Development

Development Environment

Set Up

1. Clone the repository:

git clone https://github.com/SyntaxArc/ArchiPy.git
cd ArchiPy

1. Initialize the project:

make setup

1. Install dependencies:

make install
make install-dev  # For dev tools
poetry run pre-commit install

Workflow

Code Quality

Run checks:

make check  # Runs ruff, black, mypy

Testing

Run tests:

make behave    # BDD tests
make ci        # Full pipeline

BDD tests use behave with feature files in features/ and steps in features/steps/.

Versioning

Follow Semantic Versioning:

make bump-patch  # Bug fixes
make bump-minor  # New features
make bump-major  # Breaking changes

Add a message:

make bump-minor message="Added new utility"

Build & Docs

Build the package:

make build
make clean  # Remove artifacts

Build docs:

cd docs
make html

Update dependencies:

make update