Skip to main content

Command Line Interface and Python classes for interacting with MyTardis's REST API.

Project description

travis codecov Documentation Status Updates Python 3

Command Line Interface and Python classes for interacting with MyTardis’s REST API.

Install:

pip install mytardisclient

Install latest development version:

pip install git+https://github.com/mytardis/mytardisclient.git@master#egg=mytardisclient

Example

Determine the location of the configuration file where the MyTardis URL is specified:

>>> from mtclient.conf import config
>>> config.path
'/Users/james/.config/mytardisclient/mytardisclient.cfg'
>>> config.url
'https://mytardis.example.com'

Use mytardisclient’s Dataset model class to look up a public dataset (with ID 125) from the MyTardis server, using its RESTful API:

>>> from mtclient.models.dataset import Dataset
>>> Dataset.objects.get(id=125)
<Dataset: Test Public Dataset1>

The syntax is intended to be similar to Django ORM syntax, however it is not nearly as powerful yet.

Tests

Tests can be run with:

pytest --cov=mtclient

or:

pytest --cov=mtclient --cov-report=html

Building Documentation

Documentation can be built with:

cd docs/
make html

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

mytardisclient-0.3.4.tar.gz (61.0 kB view details)

Uploaded Source

File details

Details for the file mytardisclient-0.3.4.tar.gz.

File metadata

  • Download URL: mytardisclient-0.3.4.tar.gz
  • Upload date:
  • Size: 61.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.0

File hashes

Hashes for mytardisclient-0.3.4.tar.gz
Algorithm Hash digest
SHA256 7fddeefc9cf639cddb7d2fec3c0c83b5eb8d047edcaa6bdac9868090b6fc518d
MD5 e36765abab9b6d9006a44fe879dfc4fc
BLAKE2b-256 5a8f02ce6eadae807907f890e1fc882884cee9d6d2dc0d3995e090348b3af8d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page