Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.synthesize.bio/llms.txt

Use this file to discover all available pages before exploring further.

Prerequisites

To use pysynthbio, first create an account at app.synthesize.bio. If you want to store your API token in the system keyring, you’ll also need the optional keyring package. It’s installed by default in pysynthbio 2.2.1 and later.

Standard installation

Install the latest stable version from PyPI:
pip install pysynthbio
Verify the install:
pip show pysynthbio

Development installation

Install the latest development version directly from GitHub:
git clone https://github.com/synthesizebio/pysynthbio.git
cd pysynthbio
pip install -e .

Installing from a GitHub release

You can also install a specific tagged version directly from a GitHub release. This is useful for testing pre-releases or pinning to a specific tag.
1

Find the release

Go to the releases page and find the tag you want, such as v3.0.2.
2

Download the asset

Expand the release’s Assets section and download the .whl (preferred) or .tar.gz.
3

Install with pip

# Wheel
pip install /path/to/pysynthbio-3.0.2-py3-none-any.whl

# Source distribution
pip install /path/to/pysynthbio-3.0.2.tar.gz

Next: Get started

Authenticate and make your first prediction.