buildzr
Define your C4 software architecture in Python, then build it and explore it in an interactive browser viewer.
- Write architecture as code. Describe people, systems, containers and components with Python
withblocks and>>relationships. - See it in your browser. One command,
buildzr serve, builds your model and serves a viewer that you can zoom, search and link to. - Stay compatible. buildzr produces standard Structurizr workspaces, so other Structurizr tools can read your model.
Try it now
With uv installed (it finds or fetches a compatible Python), run:
uvx buildzr serve --example
This serves a bundled example workspace and prints its address. Open it to explore the interactive viewer. You do not need a project, a model file or Node.js. If you prefer a browser tab, press Run Code on the complete Quick Start example: it runs without installing anything.
Until 1.0.0 final is out, add a pre-release flag:
uvx --prerelease allow buildzr serve --example,uv add --prerelease allow buildzr, orpip install --pre buildzr.
Use buildzr with your coding agent
Let your coding agent model your architecture for you. The buildzr skill teaches it to write model files, build them, fix build errors, serve the viewer and answer questions about your model.
Install the skill in your project:
npx skills add amirulmenjeni/buildzr
Then ask your agent:
Use buildzr to model the architecture of this repository. Read the code, create or update
the model in workspaces/, add a system context view and a container view, build it, and
tell me how to open it with buildzr serve.
The agent builds the model and tells you how to open the viewer. See Use buildzr with AI agents for the requirements and what the agent can do.
Quick Start
To write a model yourself, start a project. You need:
- Python 3.10 or newer.
- Node.js 18 or newer: when buildzr builds your model, its layout step runs on Node. Check it with
node --version. - uv. With pip, install with
pip install buildzrinstead ofuv add buildzr.
Create a project and install buildzr (use the pre-release flag from the note above until 1.0.0 final is out):
uv init hello-buildzr
cd hello-buildzr
uv add buildzr
mkdir workspaces
Save this model as workspaces/hello.py:
from buildzr.dsl import (
Workspace,
SoftwareSystem,
Person,
StyleElements,
SystemContextView,
)
with Workspace('hello') as w:
user = Person('User', description='A user of the system')
system = SoftwareSystem(
'Web Application',
description='Our main web application'
)
user >> "Uses" >> system
StyleElements(
on=[user],
shape='Person'
)
SystemContextView(
software_system_selector=system,
key='system-context',
description='System Context View',
auto_layout='tb'
)
Build and serve it:
uv run buildzr serve
Open http://127.0.0.1:8000/. The viewer shows your model; click a box to see its details. The Quick Start tutorial explains each step.
What you can do
- Model in Python. Nest elements with
with, connect them with>>, group them, and extend an existing workspace. The DSL is type-hinted, so your editor can complete it. - Draw the views you need. System landscape, system context, container, component, dynamic and deployment views, with styles and cloud-provider themes (AWS, Azure, Google Cloud, Kubernetes, Oracle Cloud).
- Build and serve.
buildzr buildwrites each workspace as static web pages.buildzr servebuilds what changed and serves them on your machine. See Serve your workspaces. - Explore in the viewer. Expand and collapse boxes, search, filter by type or tag, inspect relationships, switch between light and dark themes, and share a link to one view or element.
- Export. Save Structurizr JSON, and PlantUML, SVG or PNG files (these need Java; see Export).
- Query your model.
buildzr servealso exposes a read-only JSON Model API for scripts and CI jobs. - Run the examples in your browser. Every example in the documentation has a Run Code button that runs it without installing anything.
Learn more
- Documentation: the user guides, the command reference and the API reference.
- Roadmap: what is planned and what is done.
- Contributing: how to report an issue or send a change.
buildzr is approaching 1.0. Read the issue tracker for known problems, and open an issue if something does not work.
buildzr is released under the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for buildzr 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| buildzr-1.0.0.tar.gz | 1.2 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| buildzr-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.1 MB
Release files / buildzr-1.0.0.tar.gz
| Download URL | buildzr-1.0.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e5df99bf6f61c7b0281ecb3d6b49c15ed73e6bfa764ad98546e50dd3153fb69c
|
|
BLAKE2b-256 checksum How to use checksums |
5186b9e8a8426b6a27a5f772d7cda2befc00244beed3da2c687582f1833da5cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logRelease files / buildzr-1.0.0-py3-none-any.whl
| Download URL | buildzr-1.0.0-py3-none-any.whl |
|---|---|
| Size | 21.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e9d483ba689a8ac30363bc9a2207d1e228cf82636ec392ee19f0c8d0568ac2a0
|
|
BLAKE2b-256 checksum How to use checksums |
ccd74cfad5dc59a1dfe5baa3ff88c43a20abe7076071d6933395c2afae40cca0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logSecurity for buildzr 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for buildzr-1.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
