Python library for creating GA4GH testbed reports according to a harmonized, cross-workstream schema
Project description
GA4GH Testbed Lib
Python library for creating GA4GH testbed reports according to a harmonized, cross-workstream schema
Installation
As a prerequisite, please ensure you have Python 3 installed on your machine.
ga4gh-testbed-lib
is tested on the following Python versions:
- v3.7
- v3.8
- v3.9
- v3.10
ga4gh-testbed-lib
is a library that can be imported into your Python project.
To do so, first install it via pip
:
pip install ga4gh-testbed-lib
Note: We recommend using a Python virtual environment when building any Python project to avoid dependency conflicts with other projects on your system.
Usage
Once installed, you may import the ga4gh-testbed-lib
in your Python modules. We recommend only importing the Report
class directly:
from ga4gh.testbed.report.report import Report
...
report = Report()
More documentation to come on how to use the report library
Test
To contribute to the testbed library, you will need to clone the repository:
git clone https://github.com/ga4gh/ga4gh-testbed-lib.git
To run tests, you will need to install test dependencies (i.e. pytest):
pip install -r requirements.txt
Tests can be run via pytest
:
python -m pytest --cov
Changelog
v0.2.2
- Optional private flag for submissions
v0.2.1
- Accept json report from report object
v0.2.0
- Able to submit reports to Testbed API via standard
POST
request
v0.1.2
- Test level entity now has a
message
attribute for capturing test result summary in a single message
Maintainers
- GA4GH Tech Team ga4gh-tech-team@ga4gh.org
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
Built Distribution
Hashes for ga4gh_testbed_lib-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97dec9d7ca4df4c0962a147ad15d1a662e3eb0a1b96f70aa8f6c6ff9cdbbe758 |
|
MD5 | d605c9371907e5d5ada1ac5548721230 |
|
BLAKE2b-256 | dbc7b6080cdcaeb79594ddc4da99feb92f31873b3a016a3f0cb5b268c0afe1b4 |