# Ensembl Variant Lookup
`Ensembl Variant Lookup` provides a web-based graphical interface, allowing users to retrieve information about genetic variants based on their Reference SNP ID (RSID). This application integrates with the Ensembl Variant API to provide detailed variant information.
# Overview
`Ensembl Variant Lookup` is a Python tool built with Flask that allows users to query and retrieve information about genetic variants from the Ensembl database. It provides a user-friendly interface for searching individual variants, batch queries, and exploring gene regions. The tool is designed to streamline the retrieval of essential genetic variant data, making it a valuable resource for genomics research and exploration.
## Features
- **Single Variant Lookup:** Retrieve detailed information about a specific genetic variant using its RSID.
- **Batch Variant Lookup:** Perform batch searches by entering a list of RSIDs and obtaining information for multiple variants simultaneously.
- **Gene Lookup:** Fetch information about a specific gene, including details on associated variants.
Simplified illustration at high-level of API exposed in thie application, it includes all the API endpoints in the diagram:
```mermaid
graph TD
A[User's Browser] -->|GET /| B[Flask Application]
B -->|GET /| C[Render index.html]
C -->|Form Submission| D[Flask Application]
D -->|POST /batch| E[Render batch_results.html]
C -->|Form Submission| F[Flask Application]
F -->|POST /visualize| G[Render visualization.html]
C -->|Form Submission| H[Flask Application]
H -->|POST /variant| I[Render variant_results.html]
C -->|GET /gene_region| J[Flask Application]
J -->|GET /gene_region| K[Render gene_region_results.html]
```
This flowchart now includes the following API endpoints:
- `/batch` (POST): Batch search for variants by rsid list.
- `/variant` (POST): Search for variants by rsid.
- `/gene_region` (GET): Search for variants in a gene region.
- `/visualize` (POST): Visualize variants for a specific gene.
## Installation
Use `pip` to install the Ensembl Variant Lookup package.
``` bash
pip install ensembl-variant-lookup
```
## Usage
1. **Run the Application:**
``` bash
ensembl-variant-lookup
```
This command starts the Flask development server, and you can access the application at `http://localhost:5000` in your web browser.
2. **Access the Web Interface:**
Open your web browser and navigate to <http://localhost:5000> to use the Ensembl Variant Lookup tool.
3. **Single Variant Lookup:**
- Enter a specific RSID in the provided form.
- Click the "Fetch Variant" button to retrieve detailed information for the specified genetic variant.
4. **Batch Variant Lookup:**
- Enter a list of RSIDs (comma-separated) in the batch search form.
- Click the "Batch Search" button to obtain information for multiple variants simultaneously.
5. **Gene Lookup:**
- Enter the gene name in the gene lookup form.
- Click the "Fetch Gene Info" button to retrieve details about the specified gene.
## Screenshots
***Caption 1:*** *Screenshot of the Home Page.*
---
***Caption 2:*** *Screenshot of the Single Variant Lookup interface.*
---
***Caption 3:*** *Screenshot of the Batch Variant Lookup interface.*
---
***Caption 4:*** *Screenshot of the Gene Lookup interface.*
---
## Contributing
If you would like to contribute to this project, please contact or leave here an issue [issue](https://github.com/danymukesha/ensembl-variant-lookup/issues)
Raw data
{
"_id": null,
"home_page": "https://github.com/danymukesha/ensembl-variant-lookup",
"name": "ensembl-variant-lookup",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "api,variant,genomics-data,ensembl-rest,danymukesha",
"author": "Dany Mukesha",
"author_email": "danymukesha@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ff/51/cccf489a5b8b991ac6df91d105c351763dec7140d1fe59305633100c9a8b/ensembl_variant_lookup-0.1.2.tar.gz",
"platform": null,
"description": "# Ensembl Variant Lookup\n\n`Ensembl Variant Lookup` provides a web-based graphical interface, allowing users to retrieve information about genetic variants based on their Reference SNP ID (RSID). This application integrates with the Ensembl Variant API to provide detailed variant information.\n\n# Overview\n\n`Ensembl Variant Lookup` is a Python tool built with Flask that allows users to query and retrieve information about genetic variants from the Ensembl database. It provides a user-friendly interface for searching individual variants, batch queries, and exploring gene regions. The tool is designed to streamline the retrieval of essential genetic variant data, making it a valuable resource for genomics research and exploration.\n\n## Features\n\n- **Single Variant Lookup:** Retrieve detailed information about a specific genetic variant using its RSID.\n- **Batch Variant Lookup:** Perform batch searches by entering a list of RSIDs and obtaining information for multiple variants simultaneously.\n- **Gene Lookup:** Fetch information about a specific gene, including details on associated variants.\n\nSimplified illustration at high-level of API exposed in thie application, it includes all the API endpoints in the diagram:\n\n```mermaid\ngraph TD\n A[User's Browser] -->|GET /| B[Flask Application]\n B -->|GET /| C[Render index.html]\n C -->|Form Submission| D[Flask Application]\n D -->|POST /batch| E[Render batch_results.html]\n C -->|Form Submission| F[Flask Application]\n F -->|POST /visualize| G[Render visualization.html]\n C -->|Form Submission| H[Flask Application]\n H -->|POST /variant| I[Render variant_results.html]\n C -->|GET /gene_region| J[Flask Application]\n J -->|GET /gene_region| K[Render gene_region_results.html]\n```\n\nThis flowchart now includes the following API endpoints:\n\n- `/batch` (POST): Batch search for variants by rsid list.\n- `/variant` (POST): Search for variants by rsid.\n- `/gene_region` (GET): Search for variants in a gene region.\n- `/visualize` (POST): Visualize variants for a specific gene.\n\n## Installation\n\nUse `pip` to install the Ensembl Variant Lookup package.\n\n``` bash\npip install ensembl-variant-lookup\n```\n\n## Usage\n\n1. **Run the Application:**\n\n ``` bash\n ensembl-variant-lookup\n ```\n\n This command starts the Flask development server, and you can access the application at `http://localhost:5000` in your web browser.\n\n2. **Access the Web Interface:**\n\n Open your web browser and navigate to <http://localhost:5000> to use the Ensembl Variant Lookup tool.\n\n3. **Single Variant Lookup:**\n\n - Enter a specific RSID in the provided form.\n - Click the \"Fetch Variant\" button to retrieve detailed information for the specified genetic variant.\n\n4. **Batch Variant Lookup:**\n\n - Enter a list of RSIDs (comma-separated) in the batch search form.\n - Click the \"Batch Search\" button to obtain information for multiple variants simultaneously.\n\n5. **Gene Lookup:**\n\n - Enter the gene name in the gene lookup form.\n - Click the \"Fetch Gene Info\" button to retrieve details about the specified gene.\n\n## Screenshots\n\n\n\n***Caption 1:*** *Screenshot of the Home Page.*\n\n---\n\n\n\n***Caption 2:*** *Screenshot of the Single Variant Lookup interface.*\n\n---\n\n\n\n***Caption 3:*** *Screenshot of the Batch Variant Lookup interface.*\n\n---\n\n\n\n***Caption 4:*** *Screenshot of the Gene Lookup interface.*\n\n---\n\n\n\n\n## Contributing\n\nIf you would like to contribute to this project, please contact or leave here an issue [issue](https://github.com/danymukesha/ensembl-variant-lookup/issues)\n",
"bugtrack_url": null,
"license": "",
"summary": "a user-friendly interface for searching individual variants, batch queries, and exploring gene regions from the Ensembl database.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/danymukesha/ensembl-variant-lookup"
},
"split_keywords": [
"api",
"variant",
"genomics-data",
"ensembl-rest",
"danymukesha"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0a459ff8e4797b23b1e4fe36e28d32055d098d0ef33e9b6865dc7f5f17699253",
"md5": "2276647a90835acd0cb547f7c7d2096e",
"sha256": "f4086bafcdce62d73ca3446b8364f6c54ce83261900e324368eea76e294d7130"
},
"downloads": -1,
"filename": "ensembl_variant_lookup-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2276647a90835acd0cb547f7c7d2096e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 193425,
"upload_time": "2024-01-15T17:07:46",
"upload_time_iso_8601": "2024-01-15T17:07:46.776394Z",
"url": "https://files.pythonhosted.org/packages/0a/45/9ff8e4797b23b1e4fe36e28d32055d098d0ef33e9b6865dc7f5f17699253/ensembl_variant_lookup-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff51cccf489a5b8b991ac6df91d105c351763dec7140d1fe59305633100c9a8b",
"md5": "47363e706a544e070897f72ad074f6d8",
"sha256": "09866290af8478ef54d9a7015b8ddf99928c4895d00ffcd205ed950d707a2efe"
},
"downloads": -1,
"filename": "ensembl_variant_lookup-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "47363e706a544e070897f72ad074f6d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 192620,
"upload_time": "2024-01-15T17:07:49",
"upload_time_iso_8601": "2024-01-15T17:07:49.026623Z",
"url": "https://files.pythonhosted.org/packages/ff/51/cccf489a5b8b991ac6df91d105c351763dec7140d1fe59305633100c9a8b/ensembl_variant_lookup-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 17:07:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "danymukesha",
"github_project": "ensembl-variant-lookup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ensembl-variant-lookup"
}
JSON
