Merge pull request #4 from ga4gh/release/0.1.2

Release 0.1.2 into develop
ga4gh · Mar 22, 2022 · 0dc40d7 · 0dc40d7
2 parents 06f6a98 + b084542
commit 0dc40d7
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 55 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,2 +1,61 @@
-# ga4gh-testbed-lib
+<img src="https://www.ga4gh.org/wp-content/themes/ga4gh-theme/gfx/GA-logo-horizontal-tag-RGB.svg" alt="GA4GH Logo" style="width: 400px;"/>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.7|3.8|3.9|3.10-blue.svg?style=flat-square)](https://www.python.org/)
+[![GitHub Actions](https://img.shields.io/github/workflow/status/ga4gh/ga4gh-testbed-lib/Test/main?style=flat-square)](https://github.com/ga4gh/ga4gh-testbed-lib/actions)
+[![Coveralls](https://img.shields.io/coveralls/github/ga4gh/ga4gh-testbed-lib/main?style=flat-square)](https://coveralls.io/github/ga4gh/ga4gh-testbed-lib)
+
+# 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.1.2
+* Test level entity now has a `message` attribute for capturing test result summary in a single message
diff --git a/requirements.txt b/requirements.txt
@@ -7,7 +7,6 @@ coverage==6.3.2
 coveralls==3.3.1
 docopt==0.6.2
 docutils==0.18
-ga4gh-testbed-lib==0.1.1
 idna==3.3
 importlib-metadata==4.8.1
 iniconfig==1.1.1

diff --git a/requirements_test.txt b/requirements_test.txt
diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 import setuptools
 
 NAME = "ga4gh-testbed-lib"
-VERSION = "0.1.1"
+VERSION = "0.1.2"
 AUTHOR = "Jeremy Adams"
 EMAIL = "jeremy.adams@ga4gh.org"