strip-comments 2026.6.20__tar.gz

strip_comments-2026.6.20/MANIFEST.in

@@ -0,0 +1,16 @@
+# Ship the importable package only. Everything else (tests, docs, CI config,
+# project metadata files) is excluded so the sdist installs just the code.
+graft strip_comments
+
+prune tests
+prune docs
+prune .github
+
+exclude CLAUDE.md
+exclude README.md
+exclude LICENSE
+exclude Makefile
+exclude .gitignore
+
+global-exclude __pycache__
+global-exclude *.py[cod]

strip_comments-2026.6.20/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: strip-comments
+Version: 2026.6.20
+Summary: Strip comments and documentation from source files using tree-sitter
+Author-email: Alireza Savand <alireza.savand@gmail.com>
+Maintainer-email: Alireza Savand <alireza.savand@gmail.com>
+License-Expression: GPL-3.0-only
+Keywords: comments,docstrings,tree-sitter,source-code,tokens,llm,cli
+Platform: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Pre-processors
+Classifier: Topic :: Utilities
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: tree-sitter
+Requires-Dist: tree-sitter-python
+Provides-Extra: javascript
+Requires-Dist: tree-sitter-javascript; extra == "javascript"
+Provides-Extra: typescript
+Requires-Dist: tree-sitter-typescript; extra == "typescript"
+Provides-Extra: html
+Requires-Dist: tree-sitter-html; extra == "html"
+Provides-Extra: css
+Requires-Dist: tree-sitter-css; extra == "css"
+Provides-Extra: go
+Requires-Dist: tree-sitter-go; extra == "go"
+Provides-Extra: rust
+Requires-Dist: tree-sitter-rust; extra == "rust"
+Provides-Extra: c
+Requires-Dist: tree-sitter-c; extra == "c"
+Provides-Extra: cpp
+Requires-Dist: tree-sitter-cpp; extra == "cpp"
+Provides-Extra: java
+Requires-Dist: tree-sitter-java; extra == "java"
+Provides-Extra: ruby
+Requires-Dist: tree-sitter-ruby; extra == "ruby"
+Provides-Extra: php
+Requires-Dist: tree-sitter-php; extra == "php"
+Provides-Extra: bash
+Requires-Dist: tree-sitter-bash; extra == "bash"
+Provides-Extra: json
+Requires-Dist: tree-sitter-json; extra == "json"
+Provides-Extra: lua
+Requires-Dist: tree-sitter-lua; extra == "lua"
+Provides-Extra: swift
+Requires-Dist: tree-sitter-swift; extra == "swift"
+Provides-Extra: kotlin
+Requires-Dist: tree-sitter-kotlin; extra == "kotlin"
+Provides-Extra: toml
+Requires-Dist: tree-sitter-toml; extra == "toml"
+Provides-Extra: dockerfile
+Requires-Dist: tree-sitter-dockerfile; extra == "dockerfile"
+Provides-Extra: csharp
+Requires-Dist: tree-sitter-c-sharp; extra == "csharp"
+Provides-Extra: zig
+Requires-Dist: tree-sitter-zig; extra == "zig"
+Provides-Extra: all
+Requires-Dist: tree-sitter-javascript; extra == "all"
+Requires-Dist: tree-sitter-typescript; extra == "all"
+Requires-Dist: tree-sitter-html; extra == "all"
+Requires-Dist: tree-sitter-css; extra == "all"
+Requires-Dist: tree-sitter-go; extra == "all"
+Requires-Dist: tree-sitter-rust; extra == "all"
+Requires-Dist: tree-sitter-c; extra == "all"
+Requires-Dist: tree-sitter-cpp; extra == "all"
+Requires-Dist: tree-sitter-java; extra == "all"
+Requires-Dist: tree-sitter-ruby; extra == "all"
+Requires-Dist: tree-sitter-php; extra == "all"
+Requires-Dist: tree-sitter-bash; extra == "all"
+Requires-Dist: tree-sitter-json; extra == "all"
+Requires-Dist: tree-sitter-lua; extra == "all"
+Requires-Dist: tree-sitter-swift; extra == "all"
+Requires-Dist: tree-sitter-kotlin; extra == "all"
+Requires-Dist: tree-sitter-toml; extra == "all"
+Requires-Dist: tree-sitter-dockerfile; extra == "all"
+Requires-Dist: tree-sitter-c-sharp; extra == "all"
+Requires-Dist: tree-sitter-zig; extra == "all"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# strip-comments
+
+Strip comments and documentation from source files using tree-sitter.
+Blank lines are removed from the output by default, producing compact, token-efficient code.
+Designed for AI coding agents to read code without comment noise.
+
+## Installation
+
+### pip
+
+```bash
+pip install strip-comments
+```
+
+To support additional languages, install their tree-sitter grammar:
+
+```bash
+pip install tree-sitter-javascript tree-sitter-typescript
+```
+
+Or install all supported grammars at once:
+
+```bash
+pip install strip-comments[all]
+```
+
+### uv / uvx
+
+Run without installing:
+
+```bash
+uvx strip-comments myfile.py
+```
+
+With all languages:
+
+```bash
+uvx --with strip-comments[all] strip-comments myfile.py
+```
+
+Or install as a tool:
+
+```bash
+uv tool install strip-comments
+# with all languages
+uv tool install strip-comments[all]
+```
+
+## Supported Languages
+
+The following languages are supported. Only Python is required by default;
+other grammars are optional dependencies.
+
+| Language | Extension | Install Command |
+|----------|-----------|-----------------|
+| Python | `.py` | (included) |
+| JavaScript | `.js` | `pip install tree-sitter-javascript` |
+| TypeScript | `.ts` | `pip install tree-sitter-typescript` |
+| TSX | `.tsx` | `pip install tree-sitter-typescript` |
+| HTML | `.html` | `pip install tree-sitter-html` |
+| CSS | `.css` | `pip install tree-sitter-css` |
+| Go | `.go` | `pip install tree-sitter-go` |
+| Rust | `.rs` | `pip install tree-sitter-rust` |
+| C | `.c` | `pip install tree-sitter-c` |
+| C++ | `.cpp` | `pip install tree-sitter-cpp` |
+| Java | `.java` | `pip install tree-sitter-java` |
+| Ruby | `.rb` | `pip install tree-sitter-ruby` |
+| PHP | `.php` | `pip install tree-sitter-php` |
+| Bash | `.sh` | `pip install tree-sitter-bash` |
+| JSON | `.json` | `pip install tree-sitter-json` |
+| Lua | `.lua` | `pip install tree-sitter-lua` |
+| Swift | `.swift` | `pip install tree-sitter-swift` |
+| Kotlin | `.kt` | `pip install tree-sitter-kotlin` |
+| TOML | `.toml` | `pip install tree-sitter-toml` |
+| Dockerfile | `.dockerfile` | `pip install tree-sitter-dockerfile` |
+| C# | `.cs` | `pip install tree-sitter-c-sharp` |
+| Zig | `.zig` | `pip install tree-sitter-zig` |
+
+## Usage
+
+Strip comments from a single file:
+
+```bash
+strip-comments myfile.py
+```
+
+Process all files in a directory:
+
+```bash
+strip-comments src/
+```
+
+Pass glob patterns directly:
+
+```bash
+strip-comments "src/**/*.py"
+strip-comments "tests/test_*.py"
+```
+
+Filter by glob pattern:
+
+```bash
+strip-comments src/ --include "*.py" --exclude "test_*.py"
+```
+
+When using recursive patterns (`**`), common noise directories are automatically excluded:
+`.git/`, `node_modules/`, `__pycache__/`, `.venv/`, `venv/`, `.tox/`, `dist/`, `build/`,
+`.eggs/`, `.mypy_cache/`, `.pytest_cache/`, `.ruff_cache/`, `.idea/`, `.vscode/`, and `*.egg-info/`.
+
+To disable this and search all directories:
+
+```bash
+strip-comments src/ --include "**/*.py" --no-default-excludes
+```
+
+Pipe source through stdin (useful for editor integrations):
+
+```bash
+cat myfile.py | strip-comments --stdin --lang py
+```
+
+Output as JSON:
+
+```bash
+strip-comments src/ --json > output.json
+```
+
+## Coding Agent Integration
+
+Works with any agent that reads an instructions file. Add the snippet below to
+`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, or your tool's equivalent:
+
+````markdown
+## Tool: strip-comments
+
+When reading source files to explore or understand the codebase, use
+`strip-comments` instead of reading the raw file. It removes comments, docstrings,
+and blank lines, giving you the same code with fewer tokens.
+
+```bash
+strip-comments <file>                     # single file
+strip-comments <file1> <file2> ...        # multiple files (each under a "=== path ===" header)
+strip-comments <dir> --include "**/*.py"  # directory, recursive filter
+strip-comments "src/**/*.py"              # glob pattern
+cat <file> | strip-comments --stdin --lang py  # pipe via stdin
+```
+
+Read the raw file instead when you are about to edit it, or when the comments or
+docstrings themselves are relevant — stripped output has shifted line numbers and
+omits text, so it must not be used as the basis for edits.
+````
+
+## Options
+
+- `--json` — Output as JSON instead of plain text
+- `--include PATTERN` — Include files matching glob pattern
+- `--exclude PATTERN` — Exclude files matching glob pattern
+- `--no-default-excludes` — Do not exclude common directories
+- `--stdin` — Read source from stdin (requires `--lang`)
+- `-l, --lang` — Language for stdin mode (e.g. `py`, `.py`, `python`)
+- `--stdin-filename` — Display name for stdin output (default: `<stdin>`)
+
+## Development
+
+Run the test suite:
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+Requires Python 3.13+.

strip_comments-2026.6.20/README.md

@@ -0,0 +1,171 @@
+# strip-comments
+
+Strip comments and documentation from source files using tree-sitter.
+Blank lines are removed from the output by default, producing compact, token-efficient code.
+Designed for AI coding agents to read code without comment noise.
+
+## Installation
+
+### pip
+
+```bash
+pip install strip-comments
+```
+
+To support additional languages, install their tree-sitter grammar:
+
+```bash
+pip install tree-sitter-javascript tree-sitter-typescript
+```
+
+Or install all supported grammars at once:
+
+```bash
+pip install strip-comments[all]
+```
+
+### uv / uvx
+
+Run without installing:
+
+```bash
+uvx strip-comments myfile.py
+```
+
+With all languages:
+
+```bash
+uvx --with strip-comments[all] strip-comments myfile.py
+```
+
+Or install as a tool:
+
+```bash
+uv tool install strip-comments
+# with all languages
+uv tool install strip-comments[all]
+```
+
+## Supported Languages
+
+The following languages are supported. Only Python is required by default;
+other grammars are optional dependencies.
+
+| Language | Extension | Install Command |
+|----------|-----------|-----------------|
+| Python | `.py` | (included) |
+| JavaScript | `.js` | `pip install tree-sitter-javascript` |
+| TypeScript | `.ts` | `pip install tree-sitter-typescript` |
+| TSX | `.tsx` | `pip install tree-sitter-typescript` |
+| HTML | `.html` | `pip install tree-sitter-html` |
+| CSS | `.css` | `pip install tree-sitter-css` |
+| Go | `.go` | `pip install tree-sitter-go` |
+| Rust | `.rs` | `pip install tree-sitter-rust` |
+| C | `.c` | `pip install tree-sitter-c` |
+| C++ | `.cpp` | `pip install tree-sitter-cpp` |
+| Java | `.java` | `pip install tree-sitter-java` |
+| Ruby | `.rb` | `pip install tree-sitter-ruby` |
+| PHP | `.php` | `pip install tree-sitter-php` |
+| Bash | `.sh` | `pip install tree-sitter-bash` |
+| JSON | `.json` | `pip install tree-sitter-json` |
+| Lua | `.lua` | `pip install tree-sitter-lua` |
+| Swift | `.swift` | `pip install tree-sitter-swift` |
+| Kotlin | `.kt` | `pip install tree-sitter-kotlin` |
+| TOML | `.toml` | `pip install tree-sitter-toml` |
+| Dockerfile | `.dockerfile` | `pip install tree-sitter-dockerfile` |
+| C# | `.cs` | `pip install tree-sitter-c-sharp` |
+| Zig | `.zig` | `pip install tree-sitter-zig` |
+
+## Usage
+
+Strip comments from a single file:
+
+```bash
+strip-comments myfile.py
+```
+
+Process all files in a directory:
+
+```bash
+strip-comments src/
+```
+
+Pass glob patterns directly:
+
+```bash
+strip-comments "src/**/*.py"
+strip-comments "tests/test_*.py"
+```
+
+Filter by glob pattern:
+
+```bash
+strip-comments src/ --include "*.py" --exclude "test_*.py"
+```
+
+When using recursive patterns (`**`), common noise directories are automatically excluded:
+`.git/`, `node_modules/`, `__pycache__/`, `.venv/`, `venv/`, `.tox/`, `dist/`, `build/`,
+`.eggs/`, `.mypy_cache/`, `.pytest_cache/`, `.ruff_cache/`, `.idea/`, `.vscode/`, and `*.egg-info/`.
+
+To disable this and search all directories:
+
+```bash
+strip-comments src/ --include "**/*.py" --no-default-excludes
+```
+
+Pipe source through stdin (useful for editor integrations):
+
+```bash
+cat myfile.py | strip-comments --stdin --lang py
+```
+
+Output as JSON:
+
+```bash
+strip-comments src/ --json > output.json
+```
+
+## Coding Agent Integration
+
+Works with any agent that reads an instructions file. Add the snippet below to
+`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, or your tool's equivalent:
+
+````markdown
+## Tool: strip-comments
+
+When reading source files to explore or understand the codebase, use
+`strip-comments` instead of reading the raw file. It removes comments, docstrings,
+and blank lines, giving you the same code with fewer tokens.
+
+```bash
+strip-comments <file>                     # single file
+strip-comments <file1> <file2> ...        # multiple files (each under a "=== path ===" header)
+strip-comments <dir> --include "**/*.py"  # directory, recursive filter
+strip-comments "src/**/*.py"              # glob pattern
+cat <file> | strip-comments --stdin --lang py  # pipe via stdin
+```
+
+Read the raw file instead when you are about to edit it, or when the comments or
+docstrings themselves are relevant — stripped output has shifted line numbers and
+omits text, so it must not be used as the basis for edits.
+````
+
+## Options
+
+- `--json` — Output as JSON instead of plain text
+- `--include PATTERN` — Include files matching glob pattern
+- `--exclude PATTERN` — Exclude files matching glob pattern
+- `--no-default-excludes` — Do not exclude common directories
+- `--stdin` — Read source from stdin (requires `--lang`)
+- `-l, --lang` — Language for stdin mode (e.g. `py`, `.py`, `python`)
+- `--stdin-filename` — Display name for stdin output (default: `<stdin>`)
+
+## Development
+
+Run the test suite:
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+Requires Python 3.13+.

strip_comments-2026.6.20/pyproject.toml

@@ -0,0 +1,140 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "setuptools_scm[toml]>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "strip-comments"
+description = "Strip comments and documentation from source files using tree-sitter"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "GPL-3.0-only"
+authors = [
+    { name = "Alireza Savand", email = "alireza.savand@gmail.com" },
+]
+maintainers = [
+    { name = "Alireza Savand", email = "alireza.savand@gmail.com" },
+]
+keywords = [
+    "comments",
+    "docstrings",
+    "tree-sitter",
+    "source-code",
+    "tokens",
+    "llm",
+    "cli",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Pre-processors",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "tree-sitter",
+    "tree-sitter-python",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+javascript = ["tree-sitter-javascript"]
+typescript = ["tree-sitter-typescript"]
+html = ["tree-sitter-html"]
+css = ["tree-sitter-css"]
+go = ["tree-sitter-go"]
+rust = ["tree-sitter-rust"]
+c = ["tree-sitter-c"]
+cpp = ["tree-sitter-cpp"]
+java = ["tree-sitter-java"]
+ruby = ["tree-sitter-ruby"]
+php = ["tree-sitter-php"]
+bash = ["tree-sitter-bash"]
+json = ["tree-sitter-json"]
+lua = ["tree-sitter-lua"]
+swift = ["tree-sitter-swift"]
+kotlin = ["tree-sitter-kotlin"]
+toml = ["tree-sitter-toml"]
+dockerfile = ["tree-sitter-dockerfile"]
+csharp = ["tree-sitter-c-sharp"]
+zig = ["tree-sitter-zig"]
+all = [
+    "tree-sitter-javascript",
+    "tree-sitter-typescript",
+    "tree-sitter-html",
+    "tree-sitter-css",
+    "tree-sitter-go",
+    "tree-sitter-rust",
+    "tree-sitter-c",
+    "tree-sitter-cpp",
+    "tree-sitter-java",
+    "tree-sitter-ruby",
+    "tree-sitter-php",
+    "tree-sitter-bash",
+    "tree-sitter-json",
+    "tree-sitter-lua",
+    "tree-sitter-swift",
+    "tree-sitter-kotlin",
+    "tree-sitter-toml",
+    "tree-sitter-dockerfile",
+    "tree-sitter-c-sharp",
+    "tree-sitter-zig",
+]
+dev = [
+    "ruff",
+    "coverage",
+    "mypy",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+strip-comments = "strip_comments.cli:main"
+
+[tool.setuptools]
+zip-safe = false
+packages = ["strip_comments"]
+platforms = ["OS Independent"]
+include-package-data = false
+# Ship code only: do not bundle the LICENSE file into the wheel/sdist.
+license-files = []
+
+[tool.setuptools_scm]
+write_to = "strip_comments/_version.py"
+
+[tool.mypy]
+python_version = "3.14"
+strict = true
+ignore_missing_imports = true
+
+[tool.ruff]
+target-version = "py314"
+line-length = 120
+exclude = ["tests/fixtures", "strip_comments/_version.py"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "N",
+    "UP",
+    "B",
+    "C4",
+    "SIM",
+]
+ignore = ["E501", "SIM108"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

strip_comments-2026.6.20/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

strip_comments-2026.6.20/strip_comments/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '2026.6.20'
+__version_tuple__ = version_tuple = (2026, 6, 20)
+
+__commit_id__ = commit_id = 'g58a9e8cdf'