Skip to main content

Library with useful tools for processing genomic data

Project description

Diagho Toolkit

What is Diagho Toolkit ?

Diagho Toolkit is a python library which will read and parse a genomic file and return a generator with a pydantic model.

What database is used ?

  • OMIM
  • HGNC
  • HPO
  • gnomAD
  • gnomAD constraint
  • VCF
  • Fasta
  • GFF3

What pydantic model is returned ?

  • Clinvar
  • Feature
  • Gene
  • GnomAD
  • GnomAD_constraint
  • Pathology
  • Region
  • Sequence
  • Symptom
  • Variant

Installation

Install diagho-toolkit in pip

pip install diagho-toolkit

In your app if you want to parse a GFF3 file and get regions, you just need to call this method

from diagho_toolkit.gff3 import get_regions

get_regions(gff3_filename="gff3_file_path")

And this method will return a Generator with a list of RegionModel that you can easily save into your database.

Customize diagho-toolkit

Clone the project from github

Build and run the docker image

make docker

Into the container update and install requirements

make requirements
make install

Customize the project in the repository src/diagho_toolkit

Create and run tests

make tests

Update documentation in README.md and CHANGELOG.md and version in pyproject.toml

Leave the container and commit your release into github

git commit -am 'New commit'
git push 

Update the version in test-PyPI in github-actions with the workflow Test PyPi.

When all is ready, run the workflow Pypi to update the official new version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

diagho_toolkit-0.1.1.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

diagho_toolkit-0.1.1-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file diagho_toolkit-0.1.1.tar.gz.

File metadata

  • Download URL: diagho_toolkit-0.1.1.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for diagho_toolkit-0.1.1.tar.gz
Algorithm Hash digest
SHA256 151dcc7e826d834dd21c902348a8987a80815b6ef4176f1942009cd1f264c447
MD5 ba643daab003c49ebfadd36d9cbba21e
BLAKE2b-256 266a61e53a20d41b0fbd47552ed92d514f77169674c62406f6cb3a415b870cf8

See more details on using hashes here.

File details

Details for the file diagho_toolkit-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: diagho_toolkit-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for diagho_toolkit-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a10e938cadf9bc06f6095d2d3b012071783810a097bfe09553dfac13cdb409f
MD5 c9b5085b1513d7c05018313e6686eb1d
BLAKE2b-256 a5f5e3b33e7c27147642f46f933e2afc41ece04435f5d5c1ae2cc7659fc353d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page