Command line tool and Python client for working with Deep Origin
Project description
deeporigin
This repository contains the deeporigin CLI and
Python client, which allows you to interact with
Deep Origin from the command line and Python.
[!WARNING]
Thedeeporiginclient 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
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
File details
Details for the file deeporigin-3.14.0.tar.gz.
File metadata
- Download URL: deeporigin-3.14.0.tar.gz
- Upload date:
- Size: 146.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
23de84653c65b3d6ff10a8453ea6d38b2600f167e7d04fc7792bda9045db0555
|
|
| MD5 |
ed2313d1f73b6803049f052005dcba48
|
|
| BLAKE2b-256 |
1522b0d0235d662427bd7b1dbdadf9ba2f3e4f4f75ea8e4ad2f0ce6646486fe6
|
Provenance
The following attestation bundles were made for deeporigin-3.14.0.tar.gz:
Publisher:
pypi.yml on deeporiginbio/deeporigin-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
deeporigin-3.14.0.tar.gz -
Subject digest:
23de84653c65b3d6ff10a8453ea6d38b2600f167e7d04fc7792bda9045db0555 - Sigstore transparency entry: 186244598
- Sigstore integration time:
-
Permalink:
deeporiginbio/deeporigin-client@2cf732cfd6b5fce62eafe562e6d08bdd9b25c492 -
Branch / Tag:
refs/tags/3.14.0 - Owner: https://github.com/deeporiginbio
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@2cf732cfd6b5fce62eafe562e6d08bdd9b25c492 -
Trigger Event:
push
-
Statement type:
