('MergeTB Python client library',)
Project description
mergetblib
This package contains a client interface to the MergeTB API.
Structure
This package implements classes that reflect the core objects defined by the MergeTB API, including:
- Identity
- User
- Project
- Organization
- Experiment
- Realization
- Materialization
- XDC
Each of these classes implements a GRPC client interface that allows object data to be pushed to / pulled from a MergeTB portal.
Example
The following example shows how a user can log into a MergeTB portal and list the projects they belong to:
import mergetblib.mergetb as mergetb
from mergetblib.identity import Identity
# login
username = 'xxx' # replace with your MergeTB account username
password = 'xxx' # replace with your MergeTB account password
identity = Identity(username, password)
identity.login()
# get projects
projects = mergetb.get_projects().projects
print("Username %s has the following projects:" % username)
for project in projects:
summary="""Project: %s
Description: %s
Members: %s
Experiments: %s
Access Mode: %d
GID: %d
Organization: %s
Category: %s
Subcategory: %s""" % (
project.name,
project.description,
project.members,
project.experiments,
project.access_mode,
project.gid,
project.organization,
project.category,
project.subcategory,
)
print(summary)
API objects
Note that this package is a wrapper around the mergetbapi, a
separate Python package which provides Python language bindings for the data structures defined in
the Merge API specification. This library should be understood as a
wrapper around the mergetbapi
package that provides a more convenient interface for users to work
with.
Tests
There are tests defined in the tests directory that show further examples of how this package can be used to interact with a MergeTB portal:
- test_identity.py
- test_user.py
- test_workflow.py
To run a test, do the following. NOTE: tests must be run from the package's root directory:
python3 -m tests.test_<testname>.py
Pass the -h
option to see what command line options the test accepts; e.g., for the
test_identity
test:
python3 -m tests.test_identity -h
usage: test_identity.py [-h] [-u USERNAME] [-p PASSWORD] [-S SERVER] [-P PORT] [-X]
options:
-h, --help show this help message and exit
-u USERNAME, --username USERNAME
Username for your MergeTB account
-p PASSWORD, --password PASSWORD
Password for your MergeTB account
-S SERVER, --server SERVER
MergeTB portal GRPC address
-P PORT, --port PORT MergeTB portal GRPC port
-X, --disable-tls Disable TLS when communication with the MergeTB portal
Project details
Release history Release notifications | RSS feed
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 mergetb-1.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78cc329df483cd9b1a7329b8e90c27d40ab4ab07e4c1c7546f295a5a14f1d295 |
|
MD5 | fd7b5b5dbf91cd93d80b5cffba2c90be |
|
BLAKE2b-256 | fd7fc576c50b90e3b30c735c5f1f4169629f3da4d7df5955aadb0ef5d0dea46a |