Skip to main content

Command line tool and Python client for working with Deep Origin

Project description

deeporigin

PyPI

This repository contains the deeporigin CLI and Python client, which allows you to interact with Deep Origin from the command line and Python.

[!WARNING]
The deeporigin client is under active development. Features may change or be removed.

Installing

[!CAUTION] As a best practice, we recommend installing this package in a virtual environment.

To install this package, run the following:

pip install deeporigin

Configuration

To run this package outside of a Deep Origin workstation (for example, on your own computer), first you need to configure this package. After installing this package, run the following to configure your organization, replacing org-id with the ID of the Deep Origin organization that you would like to work with.

deeporigin config set organization_id [org-id]

Developing

First, download the source code from GitHub:

git clone git@github.com:deeporiginbio/deeporigin-client.git
cd deeporigin-client

Second, run the code below to create a virtual environment and install this package into it. This requires make v4.4 or higher.

make install

Testing

Running the tests locally

To run the tests locally, execute the following:

make test

By default, the tests are run using mocked responses. To run the tests against the live Deep Origin API, execute the following:

make test client=default

Automated tests on GitHub Actions

The tests are automatically run on GitHub Actions on every commit to every pull request.

License

MIT

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

deeporigin-2.3.0.tar.gz (60.0 kB view details)

Uploaded Source

File details

Details for the file deeporigin-2.3.0.tar.gz.

File metadata

  • Download URL: deeporigin-2.3.0.tar.gz
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for deeporigin-2.3.0.tar.gz
Algorithm Hash digest
SHA256 488e6a1c3f14fb46704efe0cd8fc0bf109db3ccfe1ec7d969fa9ce13084cd154
MD5 b146a4af7955c159f3b2b4a600807379
BLAKE2b-256 d5db889c5184ff359e003c7755b65def76608381265a70f2603c1d807f186c4e

See more details on using hashes here.

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