pyarchrules 0.1.0b0

Architecture validation library for Python projects

⚠️ This is a pre-release (beta) version. APIs may change before the stable 0.1.0 release.

Documentation

📚 Full Documentation - Getting Started, Configuration, CLI Reference, Use Cases

Features

• 🏗️ Structure validation - enforce directory tree requirements
• 🔗 Dependency rules - control module imports (e.g., api -> domain)
• 🎯 DSL & Config - use Python DSL or TOML configuration
• 🚀 Zero setup - works with pyproject.toml
• 🔍 CLI & API - integrate into CI/CD or use programmatically

Installation

pip install pyarchrules

Quick Start

# Initialize
pyarchrules init-project

# Check architecture
pyarchrules check

Configuration Example

[tool.pyarchrules]
project_name = "myapp"

[tool.pyarchrules.services.backend]
path = "src/backend"

# Enforce directory structure
tree = ["api", "domain", "infra"]
tree_strict = true

# Control dependencies (api can import from domain)
dependencies = ["api -> domain", "domain -> infra"]

Python API

from pyarchrules import PyArchRules

rules = PyArchRules()

# DSL validation
rules.for_service("backend") \
    .must_contain_folders(["api", "domain"])

result = rules.validate()

CLI Commands

Command	Description
pyarchrules init-project	Initialize configuration
pyarchrules check	Validate architecture
pyarchrules add-service NAME PATH	Add service
pyarchrules list-services	List all services

Use Cases

Monorepos - enforce boundaries between services

[tool.pyarchrules.services.auth]
path = "services/auth"
dependencies = ["auth -> shared"]

Clean Architecture - validate layer dependencies

dependencies = [
    "api -> application",
    "application -> domain"
]

Microservices - ensure consistent structure

tree = ["api", "domain", "infrastructure"]
tree_strict = true

Development

uv sync
make test
make lint

Status

⚠️ Pre-release (Beta) — 0.1.0b0 is a beta release. Core features are functional but the public API may still change before the stable 1.0 release. Not recommended for production use yet.

License

MIT