pyarchrules 0.0.1a1

Architecture validation library for Python projects

Define and enforce architectural rules for Python projects with ease.
Perfect for monorepos, microservices, and maintaining clean architecture boundaries.

Installation

pip install pyarchrules

Quick Start

Initialize in your project:

pyarchrules init-project

This creates configuration in pyproject.toml:

[tool.pyarchrules]
project_name = "my-project"
description = "Architecture rules for this project"

[tool.pyarchrules.services]
root = "."

CLI Commands

# Initialize project
pyarchrules init-project

# Add a service
pyarchrules add-service api services/api

# List services
pyarchrules list-services

# Remove a service
pyarchrules remove-service api

Configuration

Define services in pyproject.toml:

[tool.pyarchrules]
project_name = "my-project"
description = "Architecture rules"

[tool.pyarchrules.services]
root = "."

[tool.pyarchrules.services.api]
path = "services/api"

[tool.pyarchrules.services.billing]
path = "services/billing"

Python API

from pyarchrules import PyArchRules

# Load configuration
rules = PyArchRules(".")

# Access services
print(rules.services)  # {'root': '.', 'api': 'services/api', ...}

Development Status

⚠️ Alpha Release - API may change in future versions.

Development

Setup

# Install with dev dependencies
uv pip install -e ".[dev]"

Code Quality Tools

Using Make (recommended):

# Run all linters
make lint

# Auto-format code
make format

# Run tests
make test

License

MIT