{ "info": { "author": "['Pablo Riesgo Ferreiro', 'Kevin Savage', 'William Bellamy']", "author_email": "pablo.riesgo-ferreiro@genomicsengland.co.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Healthcare Industry", "Intended Audience :: Science/Research", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: Bio-Informatics" ], "description": "# pyark\n\npyark is a python client to the Clinical Variant Ark (CVA) REST API \n[https://github.com/genomicsengland/clinical_variant_ark](https://github.com/genomicsengland/clinical_variant_ark).\npyark primary aim is to facilitate access to CVA knowledge base hiding the complexity using the REST API. \nAlso by integrating with major Python data analysis libraries it aims at enabling an analytical framework on CVA.\n\n## Getting Started\n\n### Prerequisites\n\npyark works with python 2.7 up to python 3.6.\n\n### Installing\n\nInstall with pip:\n\n```\npip install clinical-variant-ark\n```\n\nYou will need a CVA server up and running and you will need credentials with the right authorisation permissions.\n\nInitialise the client:\n```python\nfrom pyark.cva_client import CvaClient\n\ncva = CvaClient(url_base=\"https://your.cva\", user=\"you\", password=\"your_secret\")\ncases_client = cva.cases()\npedigrees_client = cva.pedigrees()\nentities_client = cva.entities()\nvariants_client = cva.variants()\nreport_events_client = cva.report_events()\ntransactions_client = cva.transactions()\n```\n\nQuery CVA's knowledge base:\n```python\ncases_client.count()\n```\n\nCheck the version of the client you are using:\n```python\nimport pyark\n\nprint(\"pyark version {}\".format(pyark.VERSION))\n```\n\nSee the documentation for further usage at [https://genomicsengland.github.io/pyark/](https://genomicsengland.github.io/pyark/).\n\n## Running the tests\n\nSet the following environment variables:\n```bash\nexport CVA_URL_BASE=\"https://your.cva\"\nexport CVA_USER=\"you\"\nexport CVA_PASSWORD=\"your_secret\"\n```\n\nThen run unit tests:\n```bash\npython -m unittest discover\n```\n\nThese tests rely on a working CVA server with some data in it.\n\n## Versioning\n\nWe use [semantic versioning](http://semver.org/). The major and minor versions are aligned with the CVA backend versioning. \n\n## Authors\n\n* **Pablo Riesgo Ferreiro** [priesgo](https://github.com/priesgo)\n* **Kevin Savage** [kevinpetersavage](https://github.com/kevinpetersavage)\n* **William Bellamy** [squinker](https://github.com/squinker)\n\nSee also the list of [contributors](https://github.com/genomicsengland/pyark/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the Apache v2.0 license - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* Genomics England bioinformatics team as an infinite source of requirements\n* Katherine Smith and Augusto Rendon for spending their time playing with pyark!\n* Antonio Rueda Martin for listening to us", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/genomicsengland/pyark/archive/v4.1.3.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/genomicsengland/pyark", "keywords": "CVA,pyark,clinical variant ark,Genomics England", "license": "Apache", "maintainer": "", "maintainer_email": "", "name": "clinical-variant-ark", "package_url": "https://pypi.org/project/clinical-variant-ark/", "platform": "", "project_url": "https://pypi.org/project/clinical-variant-ark/", "project_urls": { "Download": "https://github.com/genomicsengland/pyark/archive/v4.1.3.tar.gz", "Homepage": "https://github.com/genomicsengland/pyark" }, "release_url": "https://pypi.org/project/clinical-variant-ark/4.1.3/", "requires_dist": null, "requires_python": "", "summary": "A Python client for the Clinical Variant Ark", "version": "4.1.3" }, "last_serial": 5457772, "releases": { "4.1.0": [ { "comment_text": "", "digests": { "md5": "6cf8a8bfbd3eeb510a5d257d6cca229a", "sha256": "d051efb537af6702cec200a54a5eb80d4096128b2febaf142373bd5e849567a8" }, "downloads": -1, "filename": "clinical-variant-ark-4.1.0.tar.gz", "has_sig": false, "md5_digest": "6cf8a8bfbd3eeb510a5d257d6cca229a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16271, "upload_time": "2019-06-19T14:06:32", "url": "https://files.pythonhosted.org/packages/13/05/4d73610ae9dc1a39dca4a8482f920f97c3125da39545fb271fcdbf86801c/clinical-variant-ark-4.1.0.tar.gz" } ], "4.1.1": [ { "comment_text": "", "digests": { "md5": "0251d5cae9bb65fe36009a3030e9408e", "sha256": "08612410a319aac800c87c9e8c70e0c032eaf59a145ba2676710a9946644a176" }, "downloads": -1, "filename": "clinical-variant-ark-4.1.1.tar.gz", "has_sig": false, "md5_digest": "0251d5cae9bb65fe36009a3030e9408e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16423, "upload_time": "2019-06-26T14:59:43", "url": "https://files.pythonhosted.org/packages/c4/ca/774e558f57edc9cfbc4ddd28147edbdfb14212895739c262aadb59d0ebdd/clinical-variant-ark-4.1.1.tar.gz" } ], "4.1.2": [ { "comment_text": "", "digests": { "md5": "97ecccdbb77d3f20cdf85274ab7b2892", "sha256": "f6fb91a2634f935eff982e63cfaf263f26238ac33ef3aad56fe32e37b983474b" }, "downloads": -1, "filename": "clinical-variant-ark-4.1.2.tar.gz", "has_sig": false, "md5_digest": "97ecccdbb77d3f20cdf85274ab7b2892", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16573, "upload_time": "2019-06-26T21:21:16", "url": "https://files.pythonhosted.org/packages/f8/47/4e4cb0f4118d16e89c49f8fad92579def69c39728d52bc68767f264548af/clinical-variant-ark-4.1.2.tar.gz" } ], "4.1.3": [ { "comment_text": "", "digests": { "md5": "919643d3cbb745ad87cfd1df194f2970", "sha256": "84bff6cadac11e4664fe02eaef6a5848c0d805093f8cc548639487083abfef0c" }, "downloads": -1, "filename": "clinical-variant-ark-4.1.3.tar.gz", "has_sig": false, "md5_digest": "919643d3cbb745ad87cfd1df194f2970", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16810, "upload_time": "2019-06-27T16:30:03", "url": "https://files.pythonhosted.org/packages/92/7d/8383c2286c891bdf206cf82df6a0c2d62e68cc00d765bca45cf4062c5525/clinical-variant-ark-4.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "919643d3cbb745ad87cfd1df194f2970", "sha256": "84bff6cadac11e4664fe02eaef6a5848c0d805093f8cc548639487083abfef0c" }, "downloads": -1, "filename": "clinical-variant-ark-4.1.3.tar.gz", "has_sig": false, "md5_digest": "919643d3cbb745ad87cfd1df194f2970", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16810, "upload_time": "2019-06-27T16:30:03", "url": "https://files.pythonhosted.org/packages/92/7d/8383c2286c891bdf206cf82df6a0c2d62e68cc00d765bca45cf4062c5525/clinical-variant-ark-4.1.3.tar.gz" } ] }