synbio-buildcompiler 0.0b1

BuildCompiler is a package to decouple the design and build stages

BuildCompiler

BuildCompiler is an open-source tool that bridges the Design and Build stages of the DBTL cycle by compiling SBOL-encoded genetic designs into executable DNA assembly and transformation workflows.

It was developed to support build functionality in comand line and cloud workflows in SynBioSuite, based off the SBOL Best Practices.

Installing BuildCompiler:

pip install buildcompiler

Documentation

Please visit the documentation with API reference and tutorials at Read the Docs: sbol2build.rtfd.io

Environment Setup

If you are interested in contributing to BuildCompiler, please set up your local development environment with the same tools used in CI and linting.

1. Install uv

uv manages all Python dependencies (including dev tools) with a lockfile for reproducibility.

Linux/Bash

curl -LsSf https://astral.sh/uv/install.sh | sh

Mac OSX with Homebrew

brew install uv

2. Sync dependencies

uv sync --all-groups

This will create a virtual environment with the dependiencies. Activate using:

source .venv/bin/activate

3. Install pre-commit hooks

We use pre-commit to automatically run the Ruff linter before every commit. Install and enable the hooks with:

uv run pre-commit install

Running tests:

uv run python -m unittest discover -s tests