| Name | hgvs-dataproviders-rest JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | hgvs dataproviders based on UTA and SeqRepo REST Interfaces |
| upload_time | 2023-08-04 16:00:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
fastapi
pydantic
uvicorn
hgvs
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hgvs-dataproviders-rest
Rest interface for [UTA](https://github.com/biocommons/uta) and [SeqRepo](https://github.com/biocommons/biocommons.seqrepo), which combined make up an hgvs data provider.
The uta and seqrepo databases are used by [hgvs](https://github.com/biocommons/hgvs) to perform many of its sequence manipulation functions. The hgvs library includes tools to normalize, validate, and map sequence variants (among other functionalities). In order for hgvs to access info needed for such work, it uses the uta data provider to fetch transcripts and sequences.
This package includes a REST api (restapi.py) for uta that stands between hgvs and uta/seqrepo databases, along with a data provider for hgvs (restclient.py) that acts as its client.
## Installing the Rest Interface Locally
Install docker.
$ docker pull biocommons/uta-rest:uta-rest
$ docker volume create --name=uta-rest
$ docker run -p 8000:8000 biocommons/uta-rest:uta-rest
Or without docker:
$ make devready
$ source venv/bin/activate
$ uvicorn restapi:app
## Using with hgvs
Simply pass the result of utarest's connect() function as an argument into any [hgvs](https://github.com/biocommons/hgvs) tool, e.g. Assembly Mapper.
>>> import hgvs_dataproviders_rest
>>> import hgvs.assemblymapper
>>> hdp = hgvs_dataproviders_rest.connect()
>>> am = hgvs.assemblymapper.AssemblyMapper(hdp,
... assembly_name='GRCh37', alt_aln_method='splign',
... replace_reference=True)
Instead of calling connect() from hgvs.dataproviders.uta, you are using .hgvs_dataproviders_rest. Both implement the hgvs [data providers interface](https://github.com/biocommons/hgvs/blob/main/src/hgvs/dataproviders/interface.py).
## Using with hgvs (2.0+)
A second version of hgvs is planned, which allows for selecting a data provider out of several supported options: uta, hgvs_dataproviders_rest, cdot, and possibly a future Ensembl interface implementation. See [utaclients](https://github.com/ccaitlingo/uta-clients) for more info on each data provider.
## Developer Installation
$ make devready
$ source venv/bin/activate
$ uvicorn restapi:app --reload
Raw data
{
"_id": null,
"home_page": "",
"name": "hgvs-dataproviders-rest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Reece Hart <reece@myome.com>, Caitlin Gong <caitlin.gong@myome.com>",
"download_url": "https://files.pythonhosted.org/packages/e9/19/a8192c1c5cd1a16610e366062a881a9ac2fcf6f0d489153a22bbeae7eae6/hgvs_dataproviders_rest-0.0.2.tar.gz",
"platform": null,
"description": "# hgvs-dataproviders-rest\n\nRest interface for [UTA](https://github.com/biocommons/uta) and [SeqRepo](https://github.com/biocommons/biocommons.seqrepo), which combined make up an hgvs data provider.\n\nThe uta and seqrepo databases are used by [hgvs](https://github.com/biocommons/hgvs) to perform many of its sequence manipulation functions. The hgvs library includes tools to normalize, validate, and map sequence variants (among other functionalities). In order for hgvs to access info needed for such work, it uses the uta data provider to fetch transcripts and sequences.\n\nThis package includes a REST api (restapi.py) for uta that stands between hgvs and uta/seqrepo databases, along with a data provider for hgvs (restclient.py) that acts as its client.\n\n## Installing the Rest Interface Locally\n\nInstall docker.\n\n $ docker pull biocommons/uta-rest:uta-rest\n $ docker volume create --name=uta-rest\n $ docker run -p 8000:8000 biocommons/uta-rest:uta-rest\n\nOr without docker:\n\n $ make devready\n $ source venv/bin/activate\n $ uvicorn restapi:app\n\n## Using with hgvs\n\nSimply pass the result of utarest's connect() function as an argument into any [hgvs](https://github.com/biocommons/hgvs) tool, e.g. Assembly Mapper.\n\n\n >>> import hgvs_dataproviders_rest\n >>> import hgvs.assemblymapper\n >>> hdp = hgvs_dataproviders_rest.connect()\n\n >>> am = hgvs.assemblymapper.AssemblyMapper(hdp,\n ... assembly_name='GRCh37', alt_aln_method='splign',\n ... replace_reference=True)\nInstead of calling connect() from hgvs.dataproviders.uta, you are using .hgvs_dataproviders_rest. Both implement the hgvs [data providers interface](https://github.com/biocommons/hgvs/blob/main/src/hgvs/dataproviders/interface.py).\n\n## Using with hgvs (2.0+)\n\nA second version of hgvs is planned, which allows for selecting a data provider out of several supported options: uta, hgvs_dataproviders_rest, cdot, and possibly a future Ensembl interface implementation. See [utaclients](https://github.com/ccaitlingo/uta-clients) for more info on each data provider.\n\n## Developer Installation\n\n $ make devready\n $ source venv/bin/activate\n $ uvicorn restapi:app --reload\n",
"bugtrack_url": null,
"license": "",
"summary": "hgvs dataproviders based on UTA and SeqRepo REST Interfaces",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/biocommons/hgvs-dataproviders-rest/issues",
"Homepage": "https://github.com/biocommons/hgvs-dataproviders-rest"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a22462c048d1dfbb3463496db9834ee4c2437dc1bbde39a02185cd00f20505a5",
"md5": "76ad8d8001624e511fa48073af704b92",
"sha256": "6d50265549e7af6f7134f0f78d164ef85074d963bcd8204b2d9f84464adea473"
},
"downloads": -1,
"filename": "hgvs_dataproviders_rest-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76ad8d8001624e511fa48073af704b92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8632,
"upload_time": "2023-08-04T16:00:08",
"upload_time_iso_8601": "2023-08-04T16:00:08.374805Z",
"url": "https://files.pythonhosted.org/packages/a2/24/62c048d1dfbb3463496db9834ee4c2437dc1bbde39a02185cd00f20505a5/hgvs_dataproviders_rest-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e919a8192c1c5cd1a16610e366062a881a9ac2fcf6f0d489153a22bbeae7eae6",
"md5": "4dcb65583d84934ce56317dc2827088f",
"sha256": "1bae81c86ded86991726786e69e323ddb179c12d28ebd2191a500f752f1402e0"
},
"downloads": -1,
"filename": "hgvs_dataproviders_rest-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4dcb65583d84934ce56317dc2827088f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32251,
"upload_time": "2023-08-04T16:00:10",
"upload_time_iso_8601": "2023-08-04T16:00:10.021653Z",
"url": "https://files.pythonhosted.org/packages/e9/19/a8192c1c5cd1a16610e366062a881a9ac2fcf6f0d489153a22bbeae7eae6/hgvs_dataproviders_rest-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-04 16:00:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biocommons",
"github_project": "hgvs-dataproviders-rest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "fastapi",
"specs": []
},
{
"name": "pydantic",
"specs": []
},
{
"name": "uvicorn",
"specs": []
},
{
"name": "hgvs",
"specs": []
}
],
"tox": true,
"lcname": "hgvs-dataproviders-rest"
}
