Skip to main content

Python library for creating GA4GH testbed reports according to a harmonized, cross-workstream schema

Project description

GA4GH Logo

License Python GitHub Actions Coveralls

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.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

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

ga4gh-testbed-lib-0.2.0.tar.gz (19.3 kB view hashes)

Uploaded Source

Built Distributions

ga4gh_testbed_lib-0.2.0-py3.10.egg (49.8 kB view hashes)

Uploaded Source

ga4gh_testbed_lib-0.2.0-py3-none-any.whl (25.4 kB view hashes)

Uploaded Python 3

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