Skip to main content

VICC normalization routine for genes

Project description

Gene Normalization

Services and guidelines for normalizing gene terms

Developer instructions

Following are sections include instructions specifically for developers.

Installation

For a development install, we recommend using Pipenv. See the pipenv docs for direction on installing pipenv in your compute environment.

Once installed, from the project root dir, just run:

pipenv sync

Data files

For now, data files supporting the normalizers need to be obtained independently. See issue #7 for progress on updaters.

Init coding style tests

Code style is managed by flake8 and checked prior to commit.

We use pre-commit to run conformance tests.

This ensures:

  • Check code style
  • Check for added large files
  • Detect AWS Credentials
  • Detect Private Key

Before first commit run:

pre-commit install

Running unit tests

Running unit tests is as easy as pytest.

pipenv run pytest

Starting the gene normalization service

From the project root, run the following:

 uvicorn main:app --reload

Next, view the OpenAPI docs on your local machine:

http://127.0.0.1:8000/docs

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

gene-normalizer-0.1.0.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

gene_normalizer-0.1.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file gene-normalizer-0.1.0.tar.gz.

File metadata

  • Download URL: gene-normalizer-0.1.0.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for gene-normalizer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6e49f3f8c6385396696324a019ee61de6f9bb821bd605ee86b0731fe6944c9e6
MD5 0164366e621e746e92fa8773c55b2d26
BLAKE2b-256 0e9326743e0721eae18ae0c420f1236d5d5a4dc9a2017a0e48f7a5031b64579d

See more details on using hashes here.

File details

Details for the file gene_normalizer-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: gene_normalizer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

File hashes

Hashes for gene_normalizer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1c0111a7e9f5ab5fcc880a0a180bc7ee2b91480a56489ea5247bf0ea27d69b5
MD5 297dfa82c6dff19aef6ea21761d9514a
BLAKE2b-256 276fec279a889faf8532970131bb381b3e6edab2ae09965d85d45b7fd7488963

See more details on using hashes here.

Supported by

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