Metadata-Version: 2.4
Name: deeporigin
Version: 3.31.0
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
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: cement>=3
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: httpx
Requires-Dist: deeporigin-data-sdk==0.1.0a35
Requires-Dist: humanize
Requires-Dist: packaging
Requires-Dist: diskcache
Requires-Dist: tqdm
Requires-Dist: pyjwt
Requires-Dist: cryptography
Requires-Dist: python-box
Requires-Dist: do-sdk-platform==6.0.3
Requires-Dist: urllib3>=2.0.0
Requires-Dist: more-itertools
Requires-Dist: nest_asyncio
Requires-Dist: asyncio
Requires-Dist: jinja2
Requires-Dist: aiohttp
Requires-Dist: jsonschema
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: parameterized; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: interrogate; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Requires-Dist: pytest-markdown-docs; extra == "test"
Provides-Extra: dev
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: jupyter-black; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Requires-Dist: mkdocs-material>=8.2.0; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: black; extra == "docs"
Provides-Extra: plots
Requires-Dist: bokeh; extra == "plots"
Provides-Extra: tools
Requires-Dist: rdkit; extra == "tools"
Requires-Dist: deeporigin-molstar==0.1.3; extra == "tools"
Requires-Dist: biotite; extra == "tools"
Requires-Dist: biopython; extra == "tools"
Requires-Dist: rcsb-api>=1.1.4; extra == "tools"
Dynamic: license-file

# 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 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:

```bash
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.

```bash
deeporigin config set organization_id [org-id]
```

## Developing

First, download the source code from GitHub:

```bash
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.

```bash
make install
```

## Testing

### Running the tests locally

To run the tests locally, execute the following:

```bash
make test
```

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

```bash
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
