Skip to content

formiclabs/deeporigin-client

Repository files navigation

deeporigin

PyPI

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

Warning

The deeporigin client is under active development. Features may change, or be removed.

Installation

Caution

As a best practice, we recommend installing this in a virtual environment.

For end users

pip install deeporigin

For developers

First, download from Github:

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

Using make > v4.4, e.g.:

make --version # 4.4.1

Install in a virtual env using:

make install

Configuration

Testing

Running tests locally

By default, tests are run using mocked responses. To run tests locally:

make test

If you want to run tests against a live instance:

make test client=default

Tests on GitHub Actions

Tests are run on GitHub Actions on every commit to every pull request.

License

MIT