Metadata-Version: 2.1
Name: twinlab
Version: 0.0.1
Summary: Client interface for twinLab
Home-page: https://github.com/digiLab-ai/twinLab-client
Author: Alexander Mead
Author-email: alexander@digilab.co.uk
Requires-Python: >=3.9,<3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: pandas (>=1.5.3,<2.0.0)
Requires-Dist: pydantic[dotenv] (>=1.10.7,<2.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Project-URL: Repository, https://github.com/digiLab-ai/twinLab-client
Description-Content-Type: text/markdown

# twinLab Client

<p align="center">
    <img src="./resources/icons/logo.svg" width="200" height="200" />
</p>

![digiLab](./resources/badges/digilab.svg)
[![slack](https://img.shields.io/badge/slack-@digilabglobal-purple.svg?logo=slack)](https://digilabglobal.slack.com)

Headless interface to the `twinLab` library.

## Installation

```bash
poetry install
```

## Environment setup

```bash
cp .env.example .env
```

and fill in your group and user names.

## Commands

Local or cloud testing:

```python
poetry run python scripts/trigger.py local_or_cloud
```

where the `local_or_cloud` flag is either `local` or `cloud` and where `trigger.py` can be replaced with any of the scripts in the `script` directory.
You need to have a local server for the `twinlab-cloud` repository running for local testing.

## Notebooks

Check out the `notebooks` directory for some examples to get started!

## Documentation

See the live documentation at https://digilab-ai.github.io/twinLab-client/

Or build a copy locally:

```bash
cd docs
yarn start
```

