Installation¶

Requirements¶

Python 3.10 or higher

The project follows a rolling support policy: CI tests every advertised Python minor version, new maintained versions are added when supported by dependencies, and the oldest version is dropped only at end-of-life or when tooling makes it impractical.

Install from PyPI¶

The easiest way to install buildzr is using pip:

pip install buildzr

Optional Dependencies¶

`buildzr[export-plantuml]`¶

To export your architecture diagrams directly to PlantUML format, install with the export-plantuml extra:

pip install "buildzr[export-plantuml]"

Note: This requires Java 11+ to be installed on your system, as it uses Structurizr’s Java libraries under the hood via JPype. Rendering svg/png additionally needs Graphviz (dot), unless you pass layout='smetana'. See the Export page.

Install from Source¶

If you want to install the latest development version from source:

git clone https://github.com/amirulmenjeni/buildzr.git
cd buildzr
pip install -e .

Development Installation¶

For development work, install uv and sync the locked environment:

uv sync --all-extras --locked

This installs the development, documentation, and PlantUML extras. Run tools through the project environment with uv run, for example:

uv run pytest --mypy tests

The lockfile keeps local development and CI dependencies reproducible.

Verification¶

To verify your installation, try importing buildzr:

# norun
from buildzr.dsl import Workspace, SoftwareSystem, Person
print("buildzr installed successfully!")

Or check the version:

# norun
from importlib.metadata import version
print(version("buildzr"))

Next Steps¶

Now that you have buildzr installed, head over to the Quick Start Guide to create your first architecture diagram!