PyArchRules release-0.1.0b0

Prepare first beta release (add rules, tests, update mkdocs)

Author: mspitb

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Set cache ID
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Deploy documentation
+        run: uv run mkdocs gh-deploy --force

RELEASE.md CHANGELOG.mdRELEASE.md renamed to CHANGELOG.md

@@ -1,11 +1,14 @@
-.PHONY: lint format test clean help
+.PHONY: lint format test clean docs docs-serve docs-deploy help
 
 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 test      - Run all tests"
-	@echo "  make clean     - Remove build artifacts and cache"
+	@echo "  make lint         - Run code quality checks (black, isort, ruff)"
+	@echo "  make format       - Auto-format code with black and isort"
+	@echo "  make test         - Run all tests"
+	@echo "  make docs         - Build documentation"
+	@echo "  make docs-serve   - Serve documentation locally with live reload"
+	@echo "  make docs-deploy  - Deploy documentation to GitHub Pages"
+	@echo "  make clean        - Remove build artifacts and cache"
 
 lint:
 	uv run black --check .
@@ -20,8 +23,17 @@ format:
 test:
 	uv run pytest tests/
 
+docs:
+	uv run mkdocs build
+
+docs-serve:
+	uv run mkdocs serve
+
+docs-deploy:
+	uv run mkdocs gh-deploy --force
+
 clean:
-	rm -rf dist/ build/ *.egg-info src/*.egg-info
+	rm -rf dist/ build/ *.egg-info src/*.egg-info site/
 	find . -type d -name __pycache__ -exec rm -rf {} +
 	find . -type f -name "*.pyc" -delete
 

Makefile

@@ -4,10 +4,16 @@
 
 <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.12+-blue.svg" alt="Python 3.12+"></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-beta%200.1.0b0-orange.svg" alt="Status Alpha"></a>
+  <a href="https://mspitb.github.io/pyarchrules/"><img src="https://img.shields.io/badge/docs-mkdocs-blue.svg" alt="Documentation"></a>
 </p>
 
 
+## Documentation
+
+📚 **[Full Documentation](https://mspitb.github.io/pyarchrules/)** - Getting Started, Configuration, CLI Reference, Use Cases
+
 ## Features
 
 - 🏗️ **Structure validation** - enforce directory tree requirements

README.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes are documented here.
+Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.0.1a2] — 2026-02-19
+
+### Added
+
+- `pyarchrules check` — validates architecture from the CLI
+- `pyarchrules init-project` — initialises `pyproject.toml` config
+- `pyarchrules add-service` / `remove-service` / `list-services` commands
+- `TreeRule` — validates directory tree structure
+- `DependenciesRule` — validates internal module import direction
+- `AllowedServiceDependenciesRule` — validates cross-service imports
+- `MustContainFoldersRule` DSL rule with `allow_extra` parameter
+- `PyArchRules` Python API with `for_service()` / `validate()` interface
+- `PyArchConfig` for reading/writing `pyproject.toml` via `tomlkit`
+- Pydantic-backed `ProjectSpec` and `ServiceSpec` models
+- `ConsoleViolationReporter` for human-readable output
+- `RuleEvalResult` with `is_valid`, `error_count`, `warning_count`
+
+> ⚠️ **Alpha** — API may change before 1.0.
+
+---
+
+## [0.0.1a1] — 2026-01-01
+
+Initial private release.