archy 0.4.1__tar.gz

archy-0.4.1/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Ruff lint
+        run: uv run ruff check
+
+      - name: Ruff format
+        run: uv run ruff format --check
+
+      - name: Type check (ty)
+        run: uv run ty check
+
+      - name: Tests
+        run: uv run pytest
+
+      - name: Layer rules (archy check)
+        run: uv run archy check .

archy-0.4.1/.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload built distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/archy/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download built distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish via Trusted Publishing
+        uses: pypa/gh-action-pypi-publish@release/v1

archy-0.4.1/.gitignore

@@ -0,0 +1,225 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# DeepWork (local-only review tooling)
+.deepwork/
+.deepreview
+
+# archy score history (per-checkout, not committed; one row per `archy score --record`)
+.archy/

archy-0.4.1/.pre-commit-hooks.yaml

@@ -0,0 +1,23 @@
+- id: archy-check
+  name: archy check
+  description: Enforce layer rules declared in archy.yaml
+  entry: archy check .
+  language: python
+  pass_filenames: false
+  always_run: true
+
+- id: archy-score-strict
+  name: archy score --strict
+  description: Fail if the composite quality score regresses beyond tolerance
+  entry: archy score . --strict
+  language: python
+  pass_filenames: false
+  always_run: true
+
+- id: archy-cycles
+  name: archy cycles --strict
+  description: Fail if any import cycle (size >= 2) is present
+  entry: archy cycles . --strict
+  language: python
+  pass_filenames: false
+  always_run: true

archy-0.4.1/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+## Style
+
+### No em dashes
+
+Do not use the em-dash character (Unicode codepoint U+2014) anywhere in
+the repository. Not in code, comments, docstrings, commit messages, PR
+descriptions, or documentation. Use a regular hyphen-minus (`-`) instead,
+or restructure the sentence, or use a colon, semicolon, or parentheses.
+
+This rule applies uniformly to:
+
+- Markdown files (`README.md`, `docs/*.md`, etc.)
+- Python source and tests
+- YAML config (`archy.yaml`, CI workflows)
+- Commit messages and PR bodies
+
+CI does not currently enforce this. The local DeepWork review setup flags
+violations. To search for any em-dash in the repo without embedding the
+forbidden character in the command itself:
+
+```bash
+# Python: scans every text file under . and lists those containing U+2014.
+python3 -c "from pathlib import Path; [print(p) for p in Path('.').rglob('*') if p.is_file() and chr(0x2014) in p.read_text(errors='ignore')]"
+
+# zsh / bash 4.2+: $'\u2014' expands to the em-dash codepoint at runtime.
+grep -rn $'\u2014' --include='*.md' --include='*.py' \
+  --include='*.yaml' --include='*.yml' --include='*.toml' .
+```
+
+### Other conventions
+
+See `.deepwork/review/python_conventions.md` (local-only) for the broader
+Python style notes the review tooling enforces. The short version:
+
+- `from __future__ import annotations` at the top of every module.
+- PEP 604 type syntax (`list[X]`, `str | None`).
+- `pathlib.Path` over `os.path`.
+- Frozen dataclasses for value objects; tuples (not lists) for their
+  sequence fields.
+- ruff line length 100, target py310.
+- Comments explain *why*, not *what*. If a comment merely narrates the
+  code, delete it.

archy-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alex Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

archy-0.4.1/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: archy
+Version: 0.4.1
+Summary: Architectural sensor for Python codebases
+Project-URL: Homepage, https://github.com/hslee16/archy
+Project-URL: Issues, https://github.com/hslee16/archy/issues
+Author: Alex Lee
+License: MIT License
+        
+        Copyright (c) 2026 Alex Lee
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: architecture,dependency-graph,static-analysis,tree-sitter
+Classifier: Development Status :: 1 - Planning
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: mcp>=1.27.1
+Requires-Dist: networkx>=3.2
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tree-sitter-python>=0.23
+Requires-Dist: tree-sitter>=0.23
+Description-Content-Type: text/markdown
+
+# archy
+
+> Architectural sensor for Python codebases - keeps structure honest under AI-assisted development.
+
+**Status:** v0.4.1. Usable today via:
+
+| Mode | Command |
+|---|---|
+| Inspection | `archy graph`, `archy cycles` |
+| CI governance | `archy check` (reads `archy.yaml`) |
+| One-shot score | `archy score` |
+| Trended score | `archy score --record` + `archy trend` |
+| MCP server | `archy mcp` |
+
+Benchmarks against pydantic, fastapi, flask, pytest, and archy-on-archy live in [`docs/CASE_STUDIES.md`](docs/CASE_STUDIES.md). Score design follows sentrux (modularity, acyclicity, depth, equality, geometric mean); see [`docs/LEARNINGS.md`](docs/LEARNINGS.md).
+
+## Why
+
+AI agents generate code at machine speed. Without a feedback loop on *structural* health (module coupling, import cycles, layer violations), codebases drift architecturally even when every individual change looks fine in review.
+
+`archy` watches a Python codebase, builds a live module-dependency graph, and surfaces drift through a single trended score plus a handful of actionable sub-metrics. It's designed to run in CI, in pre-commit, and as an MCP server (`archy mcp`) so coding agents can read their own architectural impact before committing.
+
+## Scope
+
+- **Python only.** The cross-language story is deliberately someone else's problem.
+- **Tree-sitter powered.** Robust to in-flight edits and partial files; survives syntax errors that would crash `ast`.
+- **Score that trends over time.** A single number per commit, persisted, plotted. Trend matters more than the absolute value.
+- **Rules as YAML.** "Layer X cannot import Y." No DSL, no plugins (yet).
+
+## Non-goals
+
+- Multi-language analysis
+- Replacing linters, type checkers, or test runners
+- Generating code or auto-fixing violations
+
+## Quick start
+
+```bash
+uv sync
+```
+
+### Inspect the graph
+
+```bash
+uv run archy graph path/to/project --internal-only
+uv run archy graph path/to/project --format json > graph.json
+uv run archy graph path/to/project --format dot | dot -Tsvg > graph.svg
+```
+
+### Find import cycles
+
+Tarjan SCCs of size >= 2. Use `--strict` in CI to fail on any cycle.
+
+```bash
+uv run archy cycles path/to/project
+uv run archy cycles path/to/project --format json
+uv run archy cycles path/to/project --strict
+```
+
+### Enforce layer rules
+
+Reads `archy.yaml` from the repo root. Exits 1 on any violation. See [Layer rules](#layer-rules-archy-check) below.
+
+```bash
+uv run archy check path/to/project
+uv run archy check path/to/project --format json
+uv run archy check path/to/project --config custom.yaml
+```
+
+### Compute a quality score
+
+Composite of modularity, acyclicity, depth, and equality (geometric mean).
+
+```bash
+uv run archy score path/to/project
+uv run archy score path/to/project --format json
+```
+
+### Track score over time
+
+Persist per-commit scores to `.archy/history.jsonl` and chart the trend.
+
+```bash
+uv run archy score path/to/project --record
+uv run archy trend path/to/project
+uv run archy trend path/to/project --last 30 --format json
+```
+
+### Regression gate
+
+Fail if the current score drops more than `--strict-tolerance` (default 0.02) below the most recent recorded run.
+
+```bash
+uv run archy score path/to/project --strict
+uv run archy score path/to/project --strict --record           # check then record
+uv run archy score path/to/project --strict --strict-tolerance 0.0
+```
+
+### Run as an MCP server
+
+Stdio transport, so AI agents can call archy directly. See [MCP server](#mcp-server-archy-mcp) below.
+
+```bash
+uv run archy mcp
+```
+
+## MCP server (`archy mcp`)
+
+`archy mcp` exposes five tools to MCP-aware AI agents (Claude Code, the Anthropic API, etc.):
+
+| Tool | Purpose |
+|---|---|
+| `archy_score` | Compute the four-metric score; optional `record=True` and `strict=True` for the same regression-gate behaviour the CLI offers. |
+| `archy_cycles` | Find import cycles. |
+| `archy_check` | Run layer rules from `archy.yaml`. |
+| `archy_trend` | Read recent score history. |
+| `archy_record_baseline` | Convenience wrapper for `archy_score(record=True)`; mirrors sentrux's `session_start`. |
+
+Wire it into Claude Code with this stanza in your config:
+
+```json
+{
+  "mcpServers": {
+    "archy": { "command": "uv", "args": ["run", "archy", "mcp"] }
+  }
+}
+```
+
+### Regression-gate semantics
+
+`--strict` reads the last row from `.archy/history.jsonl` and compares the current score against it. Drops beyond the tolerance fail with exit code 1. The default tolerance (0.02) matches the threshold sentrux's `gate` uses. This gives archy parity with sentrux's regression-gate use case while keeping the long-term JSONL history for `archy trend`.
+
+## CI integration
+
+### GitHub Action
+
+archy ships a composite action you can drop into any workflow:
+
+```yaml
+- uses: hslee16/archy@v0.4.1
+  with:
+    command: score      # score | check | cycles
+    path: .
+    strict: "true"      # fail on regression (score) or any cycle (cycles)
+```
+
+Inputs (all optional unless noted):
+
+| Input | Default | Notes |
+|---|---|---|
+| `command` | `score` | `score`, `check`, or `cycles` |
+| `path` | `.` | Project root to analyze |
+| `strict` | `true` | `score`/`cycles`: fail on regression / any cycle |
+| `strict-tolerance` | `0.02` | `score --strict` tolerance |
+| `record` | `false` | `score`: append result to `.archy/history.jsonl` |
+| `config` | (auto) | `check`: path to `archy.yaml` |
+| `python-version` | `3.10` | Python to install |
+
+### Pre-commit hook
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/hslee16/archy
+    rev: v0.4.1
+    hooks:
+      - id: archy-check          # layer rules from archy.yaml
+      - id: archy-score-strict   # regression gate against last recorded score
+      - id: archy-cycles         # fail on any import cycle
+```
+
+`archy-score-strict` reads `.archy/history.jsonl`; commit a baseline first with `archy score . --record`.
+
+## Layer rules (`archy check`)
+
+Drop an `archy.yaml` at the repo root declaring layers and forbidden directions:
+
+```yaml
+layers:
+  domain:
+    modules:
+      - "myapp.domain.**"
+  application:
+    modules:
+      - "myapp.application.**"
+  infra:
+    modules:
+      - "myapp.infra.**"
+      - "myapp.adapters.**"
+
+forbid:
+  - {from: domain, to: application}
+  - {from: domain, to: infra}
+  - {from: application, to: infra}
+```
+
+**Pattern syntax.** Dotted-name globs: `*` matches one segment, `**` matches zero or more. `myapp.domain.**` covers the package itself and every descendant. Modules must belong to at most one layer.
+
+**Discovery.** `archy check` walks PATH upward to find `archy.yaml` unless `--config` is given. Exits 1 on violation.
+
+archy enforces its own architecture this way; see [`archy.yaml`](archy.yaml) at the repo root and the `archy check .` step in `.github/workflows/ci.yml`.
+
+## Development
+
+```bash
+uv sync                    # install runtime + dev deps from uv.lock
+uv run ruff check          # lint
+uv run ruff format         # format
+uv run ty check            # type check
+uv run pytest              # tests
+```
+
+## Roadmap
+
+Next up:
+
+- [ ] `archy_impact` MCP tool: blast-radius analysis for a set of changed files
+- [ ] `archy graph` MCP tool: expose the dep graph itself for agent-side reasoning
+- [ ] Score deltas (`archy_evolution`): per-component diffs vs. the last recorded run
+- [ ] Design Structure Matrix (`archy dsm`)
+
+Shipped: tree-sitter import graph, `__init__.py` re-export resolution, Tarjan cycle detection, YAML layer rules (`archy check`), composite score (`archy score`), JSONL history + `archy trend`, MCP server (`archy mcp`), GitHub Action + pre-commit hooks.
+
+See [`docs/FUTURE.md`](docs/FUTURE.md) for the longer list and [`docs/LEARNINGS.md`](docs/LEARNINGS.md) for design notes.
+
+## Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for style rules. Notably: no em-dash characters (U+2014) anywhere in the repo.
+
+## License
+
+MIT, see [LICENSE](LICENSE).