Metadata-Version: 2.1
Name: deeporigin
Version: 1.4.1
Summary: Command line tool and Python client for working with Deep Origin
Author-email: Deep Origin <support@deeporigin.com>
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: cement>=3
Requires-Dist: confuse
Requires-Dist: pydantic>=2.5.0
Requires-Dist: python-crontab
Requires-Dist: python-dotenv
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: termcolor
Requires-Dist: validators
Requires-Dist: pandas
Requires-Dist: beartype
Requires-Dist: tabulate
Requires-Dist: filetype
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: parameterized; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: interrogate; extra == "test"
Provides-Extra: jupyter
Requires-Dist: ipykernel; extra == "jupyter"
Requires-Dist: jupyter-black; extra == "jupyter"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == "docs"
Requires-Dist: black; extra == "docs"

# deeporigin 

![PyPI](https://img.shields.io/pypi/v/deeporigin)

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. 

## Installing 

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


```bash
pip install deeporigin
```

## Developing 

First, download from Github:

```bash
git clone git@github.com:deeporiginbio/deeporigin-client.git
cd deeporigin-client
```
Using `make > v4.4`, e.g.:

```bash
make --version # 4.4.1
```

Install in a virtual env using:

```bash
make install
```

## Configuration

## Testing 

### Running tests locally 

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

```bash
make test
```

If you want to run tests against a live instance:

```bash
make test client=default
```

### Tests on GitHub Actions

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


## License 

MIT
