Skip to main content

VICC normalization routine for evidence

Project description

Evidence Normalization

Service for normalizing evidence

Developer instructions

The following sections include instructions specifically for developers.

Installation

Pipenv

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 shell
pipenv lock && pipenv sync

Pip

If you wish to install developer dependencies for evidence.dev:

pip install evidence-normalizer[dev]

If you do not need the extra dependencies:

pip install evidence-normalizer

Backend Services

Evidence Normalization relies on Variation Normalization for normalizing Cancer Hotspots data. You will need to setup backend services and set the appropriate environment variables. See the README for more information.

Starting the Evidence Normalization Service Locally

To start the service, run the following:

uvicorn evidence.main:app --reload

Next, view the OpenAPI docs on your local machine: http://127.0.0.1:8000/evidence

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

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

evidence-normalizer-0.0.3a6.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

evidence_normalizer-0.0.3a6-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file evidence-normalizer-0.0.3a6.tar.gz.

File metadata

  • Download URL: evidence-normalizer-0.0.3a6.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for evidence-normalizer-0.0.3a6.tar.gz
Algorithm Hash digest
SHA256 16f6a1155ca5a8ac8aa8f8258ea3a14479799f16186808163d5c3adc078f99e8
MD5 dc7f5282d623f2c9cba04e6c75b34acf
BLAKE2b-256 54edcae12082452eddca90361344bd979f48e4409fe203701597fe0cac8d5668

See more details on using hashes here.

File details

Details for the file evidence_normalizer-0.0.3a6-py3-none-any.whl.

File metadata

File hashes

Hashes for evidence_normalizer-0.0.3a6-py3-none-any.whl
Algorithm Hash digest
SHA256 8596ce65530d02407a0ac1cd8b0bf0b4399c7843cc791f466f040ae430848411
MD5 ecdaf535b84c3f77975bef22e3d4016f
BLAKE2b-256 33f2997d08f83e1b211c410ea117d6fd40dd436caeeb80ffe625f6fd3e22736f

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