Metadata-Version: 2.4
Name: synaster-client
Version: 0.12.1
Summary: Official Python SDK and CLI for SynAster
Project-URL: Homepage, https://syn-aster.bohrium.com
Project-URL: Documentation, https://syn-aster.bohrium.com
Project-URL: Repository, https://github.com/macroversus/SynAsterHub
Project-URL: Issues, https://github.com/macroversus/SynAsterHub/issues
Author: SynAster Team
Keywords: ai-for-science,bioinformatics,bohrium,cli,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: httpx>=0.28
Description-Content-Type: text/markdown

# synaster-client

Official lightweight Python SDK and `synaster` command-line client for
SynAster. It calls the existing Bohrium OpenAPI and does not install or run
FastAPI, Celery, Redis, Nextflow, or scientific tool containers.

Requires Python 3.10 or newer.

## Install

```bash
pipx install synaster-client
synaster --version

# one-off execution
uvx --from synaster-client synaster --version
```

The console script and module entrypoint are equivalent:

```bash
synaster skills --json
python -m synaster_client skills --json
```

## Authenticate and run

AccessKey values are only accepted from `SYNASTER_ACCESS_KEY` or one line of
stdin via `--access-key-stdin`. There is intentionally no
`--access-key VALUE` option, and secret values are rejected in config files.

```bash
export SYNASTER_ACCESS_KEY="<your Bohrium AccessKey>"

synaster doctor
synaster describe adabmdca
synaster run adabmdca \
  --input family_msa.fasta \
  --file query=query.fasta
```

Use `submit` for a one-shot POST, then resume from the returned task ID:

```bash
synaster submit tmpred --input proteins.fasta
synaster wait <task-id>
synaster download <task-id>
```

For `--mode bohr`, the CLI refreshes live machine prices and requires an
explicit per-command charge confirmation. POST requests are never
automatically retried.

See the repository's `docs/synaster-cli-sop.md` for the complete command,
JSON, exit-code, recovery, download, and Python SDK reference.
