Merge pull request #9 from mspitb/release-0.1.0b0

PyArchRules beta-release 0.0.1b0

Author: mspitb

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 | Version | Date       | Author         | Changes                                                                                                                                                                                                                                                                   |
 |---------|------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 0.1.0b0 | 2026-02-23 | Sergei Mikheev | **Beta release preparations** <br>• Update DSL rules, fix issues <br>• Update mkdocs <br>• Add contributing document                                                                                                                                                      |
 | 0.0.1a2 | 2026-02-19 | Sergei Mikheev | **DSL and linter rules updates**<br>• Update Readme docs                                                                                                                                                                                                                  |
 | 0.0.1a1 | 2026-02-18 | Sergei Mikheev | **Code quality and design improvements**<br>• Improve core module design<br>• Add DSL rules<br>• Simplified docstrings across core modules<br>• Add linting features (project tree, dependencies graph)                                                                   |
 | 0.0.1a0 | 2026-02-17 | Sergei Mikheev | **Initial alpha release**<br>• CLI commands: `init-project`, `add-service`, `remove-service`, `list-services`<br>• Configuration management via pyproject.toml<br>• Interactive CLI prompts<br>• Service name validation<br>• Support for monorepo/multi-service projects |

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+Thank you for your interest in contributing to PyArchRules.
+
+## Before you start
+
+- For bug fixes and small improvements, open a pull request directly.
+- For larger changes or new features, open an issue first to discuss the approach.
+
+## Setup
+
+```bash
+git clone https://github.com/mspitb/pyarchrules
+cd pyarchrules
+uv sync --all-extras
+```
+
+## Running tests
+
+```bash
+make test
+```
+
+All tests must pass before a pull request will be reviewed.
+
+## Linting
+
+```bash
+make lint    # check
+make format  # auto-fix
+```
+
+## Pull request checklist
+
+- [ ] Tests added or updated for the change
+- [ ] All tests pass (`make test`)
+- [ ] No lint errors (`make lint`)
+- [ ] Docstrings updated if public API changed
+- [ ] `CHANGELOG.md` updated with a short description under `Unreleased`
+
+## Project structure
+
+```
+src/pyarchrules/
+  cli.py                 # Typer CLI commands
+  pyarchrules.py         # PyArchRules public class
+  core/
+    config.py            # pyproject.toml read/write
+    spec_loader.py       # parses TOML into model objects
+    registries/          # DSLRegistry, LinterRegistry
+    rules/
+      dsl/               # Python DSL rule implementations
+      linter/            # TOML-driven rule implementations
+      base/              # shared base classes
+      checks/            # low-level file/import scanners
+  model/
+    spec/                # ProjectSpec, ServiceSpec
+    rules/               # RuleViolation, RuleEvalResult
+tests/
+  cli/                   # CLI integration tests
+  unit/                  # unit tests per rule and component
+    dsl/                 # DSL rule unit tests
+```
+
+## License
+
+By contributing you agree that your changes will be released under the [MIT License](LICENSE).
+

Makefile

@@ -2,20 +2,18 @@
 
 help:
 	@echo "Available commands:"
-	@echo "  make lint      - Run code quality checks (black, isort, ruff)"
-	@echo "  make format    - Auto-format code with black and isort"
+	@echo "  make lint      - Run ruff linter and format check"
+	@echo "  make format    - Auto-format code with ruff"
 	@echo "  make test      - Run all tests"
 	@echo "  make clean     - Remove build artifacts and cache"
 
 lint:
-	uv run black --check .
-	uv run isort --check-only .
-	uv run ruff check .
+	uv run ruff check src/
+	uv run ruff format --check src/
 
 format:
-	uv run black .
-	uv run isort .
-	uv run ruff check --fix .
+	uv run ruff format src/
+	uv run ruff check --fix src/
 
 test:
 	uv run pytest tests/
@@ -24,4 +22,3 @@ clean:
 	rm -rf dist/ build/ *.egg-info src/*.egg-info
 	find . -type d -name __pycache__ -exec rm -rf {} +
 	find . -type f -name "*.pyc" -delete
-

README.md

@@ -4,111 +4,96 @@
 
 <p align="center">
   <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
-  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="Python 3.10+"></a>
-  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/status-alpha%200.0.1a2-orange.svg" alt="Status Alpha"></a>
+  <a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12+-blue.svg" alt="Python 3.12+"></a>
+  <a href="https://github.com/mspitb/pyarchrules"><img src="https://img.shields.io/badge/status-beta%200.1.0b0-orange.svg" alt="Status: Beta"></a>
 </p>
 
+**PyArchRules** enforces architecture rules in Python projects:
 
-## 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
+- 🏗️ **Folder structure** — require exact directory layouts per service
+- 🔗 **Dependency rules** — control which internal packages may import from which
+- 🛡️ **Service isolation** — prevent cross-service imports in monorepos
+- 🐍 **Python DSL** — write rules in Python inside your test suite
+- ⚙️ **Zero extra config** — everything lives in `pyproject.toml`
+- 🚀 **CI-ready** — exit code `1` on any violation
 
 ## Installation
 
 ```bash
 pip install pyarchrules
 ```
 
-## Quick Start
+## Quick start
 
 ```bash
-# Initialize
+# 1. Add [tool.pyarchrules] to pyproject.toml
 pyarchrules init-project
 
-# Check architecture
+# 2. Register a service
+pyarchrules add-service backend src/backend
+
+# 3. Run the check
 pyarchrules check
 ```
 
-## Configuration Example
+## TOML configuration
 
 ```toml
 [tool.pyarchrules]
-project_name = "myapp"
+project_name     = "myapp"
+description      = "Architecture rules for this project"
+root             = "."
+validate_paths   = true
+isolate_services = true
 
 [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"]
+path         = "src/backend"
+tree         = ["api", "domain", "infra"]
+tree_strict  = true
+dependencies = ["api -> domain", "domain -> infra", "* -> utils"]
 ```
 
-## Python API
+## Python DSL
 
 ```python
+# tests/test_architecture.py
 from pyarchrules import PyArchRules
 
-rules = PyArchRules()
-
-# DSL validation
-rules.for_service("backend") \
-    .must_contain_folders(["api", "domain"])
-
-result = rules.validate()
+def test_architecture():
+    rules = PyArchRules()
+    rules.for_service("backend") \
+        .must_contain_folders(["api", "domain", "infra"], allow_extra=False) \
+        .no_wildcard_imports() \
+        .no_circular_imports()
+    rules.validate()
 ```
 
-## CLI Commands
+## 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 |
+| `init-project` | Initialise `[tool.pyarchrules]` in `pyproject.toml` |
+| `add-service NAME PATH` | Register a service |
+| `remove-service NAME` | Remove a service |
+| `list-services` | Show all configured services |
+| `check` | Validate architecture |
 
-## Use Cases
-
-**Monorepos** - enforce boundaries between services
-```toml
-[tool.pyarchrules.services.auth]
-path = "services/auth"
-dependencies = ["auth -> shared"]
-```
+## Documentation
 
-**Clean Architecture** - validate layer dependencies
-```toml
-dependencies = [
-    "api -> application",
-    "application -> domain"
-]
-```
+Full documentation: <https://mspitb.github.io/pyarchrules>
 
-**Microservices** - ensure consistent structure
-```toml
-tree = ["api", "domain", "infrastructure"]
-tree_strict = true
-```
+## Contributing
 
-## Development
+Contributions are welcome. Please open an issue before submitting a pull request for non-trivial changes.
 
 ```bash
-uv pip install -e ".[dev]"
+git clone https://github.com/mspitb/pyarchrules
+cd pyarchrules
+uv sync --all-extras
 make test
 make lint
 ```
 
-## Status
-
-⚠️ **Alpha** - API may change before 1.0 release
-
 ## License
 
 MIT
-