Installation

Prerequisites

To start using pysynthbio, first you need to have an account with synthesize.bio. Go here to create one.

If you want to store your token in the system keyring, you need to install the keyring package.

Standard Installation

You can install the latest stable version using pip:

pip install pysynthbio

To ensure it installed correctly you can run:

pip show pysynthbio

Development Installation

Install the latest development version directly from the repository:

git clone https://github.com/synthesizebio/pysynthbio.git
cd pysynthbio
pip install -e .

Installing from a GitHub Release

Alternatively, you can install a specific version directly from its GitHub Release page. This is useful for testing pre-releases or specific tagged versions.

1. Go to the Releases page of the repository.

2. Find the release tag you want to install (e.g., v2.2.1).

3. Expand the “Assets” section for that release.

4. Download the .whl (wheel) file or the .tar.gz (source distribution) file. The wheel file is generally preferred if available for your platform.

5. Install the downloaded file using pip:

# Example using a downloaded wheel file
pip install /path/to/pysynthbio-2.2.1-py3-none-any.whl

# Example using a downloaded source distribution
pip install /path/to/pysynthbio-2.2.1.tar.gz