Skip to main content

IPR

build PyPi codecov PyPI - Downloads DOI

This repository is part of the Platform for Oncogenomic Reporting and Interpretation (PORI).

This python tool takes in variant inputs as tab-delimited files and annotates them using GraphKB. The resulting output is uploaded to IPR as a report. Additional report content such as images and metadata can be passed to be included in the report upload.

For documentation on how to create reports using this adaptor, see the main documentation site for the platform.

Getting Started

Install (For developers)

clone this repository

git clone https://github.com/bcgsc/pori_ipr_python.git
cd pori_ipr_python

create a virtual environment

python3 -m venv venv
source venv/bin/activate

install the package and its development dependencies

pip install -U pip setuptools
pip install -e .[dev]

Run the tests

pytest tests

Documentation

The user documentation for this tool is hosted with the main documentation site.

Developers: Any updates to this tool should be edited and reflected in the main site documentation as well.

Metadata

Release files for ipr 3.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipr 3.13.0
File Size Uploaded Provenance Actions
ipr-3.13.0.tar.gz 54.8 kB Without provenance Details for ipr-3.13.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ipr 3.13.0
File Interpreter ABI Platform Actions
ipr-3.13.0-py3-none-any.whl Python 3 none any Details for ipr-3.13.0-py3-none-any.whl

Total release size: 115.9 kB

Release files / ipr-3.13.0.tar.gz

Download URL ipr-3.13.0.tar.gz
Size 54.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6ea67de2faeec895d09d442a0fecdbd3834dc85492951699040b3bc679bbf62c
BLAKE2b-256 checksum
How to use checksums
94642a994294af554a8f8768471473769c18e0882a65d23e435607317de6863d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / ipr-3.13.0-py3-none-any.whl

Download URL ipr-3.13.0-py3-none-any.whl
Size 61.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e576d700d8f32279f11057cc21c49f7c2a27c03841eec27ed56f16e02bfe890
BLAKE2b-256 checksum
How to use checksums
f047ce9c84ac5c07ecfc5996559e87ee32bdca6c6d78078c69a122a4bc270159
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Security for ipr 3.13.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page