api-squash 0.1.0__tar.gz

api_squash-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - run: uv run ruff check src/ tests/
+      - run: uv run ruff format --check src/ tests/
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - run: uv sync --locked --dev
+      - run: uv run pytest -v --cov=api_squash --cov-report=xml
+      - if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml

api_squash-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uv python install 3.13
+      - run: uv build
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl -- python -c "from api_squash.cli import cli; print('ok')"
+      - name: Smoke test (sdist)
+        run: uv run --isolated --no-project --with dist/*.tar.gz -- python -c "from api_squash.cli import cli; print('ok')"
+      - run: uv publish

api_squash-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

api_squash-0.1.0/AGENTS.md

@@ -0,0 +1,27 @@
+# AGENTS.md
+
+## Build & Run
+
+- **Package manager:** uv
+- **Install deps:** `uv sync`
+- **Run tests:** `uv run pytest -v`
+- **Lint:** `uv run ruff check src/ tests/`
+- **Format:** `uv run ruff format src/ tests/`
+- **CLI:** `uv run api-squash --help`
+
+> **Note:** Python is not directly on PATH in this environment. Always use `uv run` for all Python commands.
+
+## Project Structure
+
+- Source code: `src/api_squash/`
+- Tests: `tests/`
+- Specs: `docs/superpowers/specs/`
+- Plans: `docs/superpowers/plans/`
+
+## Conventions
+
+- TDD: Write failing tests first, then implement
+- Use `pathlib.Path` throughout, never raw string paths
+- Output uses forward slashes in file path headers regardless of OS
+- All file I/O uses `encoding="utf-8"` explicitly
+- Frequent, atomic commits with conventional commit messages

api_squash-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to api-squash
+
+Thanks for your interest in contributing! This document describes the branching
+strategy and workflow used in this project.
+
+## Branching Strategy
+
+We use a **gitflow-style** branching model:
+
+```
+main          ← production-ready, tagged releases only
+  └── develop ← integration branch, always ahead of or equal to main
+        ├── feature/  ← new features
+        ├── fix/      ← bug fixes
+        └── chore/    ← maintenance tasks
+```
+
+- **`main`** — stable, release-only branch. Every commit on `main` is a
+  tagged release.
+- **`develop`** — integration branch where feature and fix branches merge
+  into. This is the default branch.
+
+## Development Workflow
+
+### Feature / Fix / Chore
+
+1. Branch from `develop`:
+   ```bash
+   git checkout develop
+   git pull origin develop
+   git checkout -b feature/my-feature   # or fix/, chore/
+   ```
+2. Make frequent, atomic commits using
+   [conventional commit](https://www.conventionalcommits.org/) messages
+   (e.g. `feat: add parser`, `fix: handle empty input`).
+3. Open a pull request targeting **`develop`**.
+4. After review, merge into `develop` (squash-merge or regular merge).
+
+### Releases
+
+1. When `develop` is ready for release, open a PR from `develop` → `main`.
+2. Review and merge into `main`.
+3. Tag the merge commit on `main` with a semver tag (e.g. `v0.2.0`).
+4. Merge `main` back into `develop` to pick up the merge/tag commit.
+
+### Hotfixes
+
+1. Branch from `main` → `fix/<description>`.
+2. Fix the issue, open a PR into `main`, and tag a patch release.
+3. Merge `main` back into `develop` to keep branches in sync.
+
+## Development Setup
+
+```bash
+# Requires Python >= 3.10 and uv (https://docs.astral.sh/uv/)
+uv sync
+
+# Run tests
+uv run pytest -v
+
+# Lint
+uv run ruff check src/ tests/
+
+# Format
+uv run ruff format src/ tests/
+```
+
+## Code Conventions
+
+- **TDD** — write failing tests first, then implement.
+- Use `pathlib.Path` throughout; never use raw string paths.
+- All file I/O uses `encoding="utf-8"` explicitly.
+- Output uses forward slashes in file path headers regardless of OS.
+- Use conventional commit messages (`feat:`, `fix:`, `chore:`, `docs:`, etc.).

api_squash-0.1.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: api-squash
+Version: 0.1.0
+Summary: Extract Python API surfaces in a compact, token-efficient format
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0

api_squash-0.1.0/README.md

@@ -0,0 +1,195 @@
+# api-squash
+
+> Extract Python API surfaces in a compact, token-efficient format.
+
+[![CI](https://github.com/b-j-karl/api-squash/actions/workflows/ci.yml/badge.svg)](https://github.com/b-j-karl/api-squash/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/b-j-karl/api-squash/graph/badge.svg)](https://codecov.io/gh/b-j-karl/api-squash)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+## Overview
+
+Agentic AI workflows need to understand a codebase's API surface without
+burning context on implementation details. Pasting entire source files into a
+prompt wastes tokens on function bodies, comments, and boilerplate that the
+agent doesn't need.
+
+**api-squash** parses Python source files using the AST and produces concise
+Markdown summaries containing only the public API surface — classes, functions,
+and their signatures — so AI agents can ingest a full project's interface in a
+fraction of the tokens.
+
+Built for agentic AI workflows: code-generation agents, autonomous refactoring
+pipelines, and any system where an LLM needs to reason about code structure
+programmatically.
+
+## Installation
+
+```bash
+pip install api-squash
+```
+
+For development:
+
+```bash
+# Requires the uv package manager (https://docs.astral.sh/uv/)
+uv sync
+```
+
+## Quick Start
+
+Summarize a single file:
+
+```bash
+api-squash file path/to/module.py
+```
+
+Summarize an entire project:
+
+```bash
+api-squash project path/to/project/
+```
+
+### Example
+
+Given a file `example_api.py`:
+
+```python
+"""Client for the Acme API."""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Config:
+    """Connection settings."""
+    host: str
+    port: int = 443
+    timeout: float = 30.0
+
+
+class AcmeClient:
+    """High-level client for the Acme REST API."""
+
+    def __init__(self, config: Config) -> None:
+        self._config = config
+
+    async def get_user(self, user_id: int) -> dict:
+        """Fetch a single user by ID."""
+        ...
+
+    async def list_users(self, *, active: bool = True) -> list[dict]:
+        """Return all users, optionally filtered."""
+        ...
+
+    def _build_url(self, path: str) -> str:
+        ...
+```
+
+Running `api-squash file example_api.py` produces:
+
+```
+# example_api.py
+
+class Config:
+  Connection settings.
+
+class AcmeClient:
+  High-level client for the Acme REST API.
+  def __init__(self, config: Config) -> None
+  async def get_user(self, user_id: int) -> dict
+    Fetch a single user by ID.
+  async def list_users(self, *, active: bool = True) -> list[dict]
+    Return all users, optionally filtered.
+  def _build_url(self, path: str) -> str
+```
+
+With `--no-docstrings --no-private`, the output shrinks further:
+
+```
+# example_api.py
+
+class Config:
+
+class AcmeClient:
+  def __init__(self, config: Config) -> None
+  async def get_user(self, user_id: int) -> dict
+  async def list_users(self, *, active: bool = True) -> list[dict]
+```
+
+## CLI Reference
+
+### `api-squash file`
+
+Summarize a single Python file.
+
+```
+Usage: api-squash file [OPTIONS] PATH
+```
+
+| Option | Description |
+|---|---|
+| `--no-docstrings` | Strip all docstrings from the output |
+| `--no-private` | Skip private methods (names starting with `_`), except `__init__` |
+
+### `api-squash project`
+
+Summarize all Python files in a directory.
+
+```
+Usage: api-squash project [OPTIONS] PATH
+```
+
+| Option | Description |
+|---|---|
+| `--max-depth INTEGER` | Limit directory recursion depth |
+| `--exclude TEXT` | Glob patterns to exclude (can be repeated) |
+| `--no-docstrings` | Strip all docstrings from the output |
+| `--no-private` | Skip private methods (names starting with `_`), except `__init__` |
+
+Common directories like `__pycache__`, `.venv`, `.git`, `node_modules`,
+`build`, and `dist` are skipped automatically.
+
+## Output Format
+
+api-squash produces Markdown-style output designed for easy reading and
+token-efficient LLM consumption:
+
+- **File headers** — each module starts with `# path/to/file.py`
+- **Classes** — rendered as `class Name(Base):` with docstrings indented below
+- **Functions / methods** — rendered as `def name(signature) -> return_type`
+  with docstrings indented below
+- **Separators** — in project mode, modules are separated by `---`
+
+## Development
+
+**Prerequisites:** Python ≥ 3.10, [uv](https://docs.astral.sh/uv/)
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run pytest -v
+
+# Lint
+uv run ruff check src/ tests/
+
+# Format
+uv run ruff format src/ tests/
+```
+
+## Project Structure
+
+```
+src/api_squash/
+├── cli.py          # Click CLI entry points
+├── extractor.py    # AST-based API extraction
+├── models.py       # Data models (ModuleSummary, ClassSummary, FunctionSummary)
+├── renderer.py     # Markdown output rendering
+└── scanner.py      # Directory scanning with exclusion patterns
+```
+
+## License
+
+[MIT](LICENSE)

api_squash-0.1.0/docs/skills/api-squash-cli/README.md

@@ -0,0 +1,23 @@
+# api-squash-cli Skill
+
+Pre-built skills for teaching AI coding agents how to use `api-squash`.
+
+## Installation
+
+### Copilot CLI
+
+```bash
+# Copy the Copilot skill into your user skills directory
+cp -r copilot ~/.copilot/skills/api-squash-cli
+```
+
+### Claude Code
+
+```bash
+# Copy the Claude skill into your user skills directory
+cp -r claude ~/.claude/skills/api-squash-cli
+```
+
+After installing, the skill will auto-trigger when you ask your agent to
+summarise a Python API, understand codebase structure, or gather interface
+context before code generation.