Installation

Requirements

• Python 3.10 or higher

Install from PyPI

The easiest way to install buildzr is using pip:

pip install buildzr

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, you’ll want to install the development dependencies:

pip install -e ".[dev]"

This will install additional tools including:

• mypy - Static type checker
• pytest - Testing framework
• jsondiff - JSON comparison for tests
• datamodel-code-generator - Code generation from schemas

Using Conda

If you prefer using Conda, you can create an environment using the provided environment.yml:

conda env create -f environment.yml
conda activate buildzr-dev

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 buildzr.__about__ import __version__
print(f"buildzr version: {__version__}")

Next Steps

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