reqbuild 0.1.0__tar.gz

reqbuild-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 reqbuild contributors
+
+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.

reqbuild-0.1.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: reqbuild
+Version: 0.1.0
+Summary: Automatically generate requirements.txt from your Python project using AST analysis.
+License: MIT
+Keywords: requirements,dependencies,pip,packaging,ast
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: hatch; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file
+
+# reqbuild
+
+> Automatically generate `requirements.txt` from your Python project using AST analysis — no imports, no installation needed at scan time.
+
+[![PyPI version](https://badge.fury.io/py/reqbuild.svg)](https://pypi.org/project/reqbuild/)
+[![Python](https://img.shields.io/pypi/pyversions/reqbuild.svg)](https://pypi.org/project/reqbuild/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Features
+
+- 🔍 **AST-based** — parses your source files without running them
+- 🌐 **Smart resolution** — uses the [pipreqs](https://github.com/bndr/pipreqs) mapping + live PyPI fallback
+- 🚫 **Zero dependencies** — only the Python standard library
+- 🔘 **Optional import detection** — spots imports inside `try/except ImportError` blocks
+- 🎛️ **Flexible CLI** — control scope, exclusions, output format, and more
+
+---
+
+## Installation
+
+```bash
+pip install reqbuild
+```
+
+---
+
+## Quick Start
+
+```bash
+# Scan only the current folder
+reqbuild generate
+
+# Scan everything recursively
+reqbuild generate -a
+
+# Preview without writing a file
+reqbuild generate -a --print
+```
+
+---
+
+## CLI Reference
+
+### `reqbuild generate` (alias: `gen`)
+
+Scan Python files and generate a requirements file.
+
+| Flag | Description |
+|------|-------------|
+| `-a`, `--all` | Scan the current folder **and all subdirectories** recursively |
+| `-e DIR` | Exclude a directory name (repeatable: `-e tests -e docs`) |
+| `-ef FILE` | Exclude a specific filename (repeatable: `-ef conftest.py`) |
+| `-o FILENAME` | Output filename (default: `requirements.txt`). Use `.in` for pip-compile |
+| `--print` | Print resolved dependencies to stdout instead of writing a file |
+| `--optional` | Detect imports inside `try/except ImportError` and list them as comments |
+| `--no-network` | Offline mode — skip pipreqs download and PyPI checks |
+| `-h`, `--help` | Show help for this command |
+
+### Global flags
+
+| Flag | Description |
+|------|-------------|
+| `-V`, `--version` | Show the installed version |
+
+---
+
+## Examples
+
+```bash
+# Generate requirements.in (pip-compile compatible)
+reqbuild generate -a -o requirements.in
+
+# Exclude test and docs directories
+reqbuild generate -a -e tests -e docs
+
+# Exclude a specific file
+reqbuild generate -a -ef setup.py
+
+# Detect optional imports (try/except ImportError)
+reqbuild generate -a --optional
+
+# Offline mode (no network calls)
+reqbuild generate -a --no-network
+
+# Preview all dependencies without writing
+reqbuild generate -a --print
+```
+
+---
+
+## Optional import detection
+
+With `--optional`, reqbuild will detect imports wrapped in `try/except ImportError`:
+
+```python
+import requests          # required — goes to requirements.txt
+
+try:
+    import ujson         # optional — listed as a comment
+except ImportError:
+    import json as ujson
+```
+
+Output (`requirements.txt`):
+```
+requests
+
+# ─── Optional dependencies (detected inside try/except ImportError) ───
+# ujson
+```
+
+---
+
+## Default ignored directories
+
+reqbuild automatically ignores:
+
+`.venv`, `venv`, `.env`, `env`, `__pycache__`, `.git`, `.hg`, `.svn`,
+`.tox`, `.nox`, `dist`, `build`, `site-packages`, `.mypy_cache`,
+`.pytest_cache`, `.ruff_cache`, `node_modules`, `.eggs`
+
+Add more with `-e`:
+
+```bash
+reqbuild generate -a -e migrations -e fixtures
+```
+
+---
+
+## Python API
+
+reqbuild can also be used as a library:
+
+```python
+from reqbuild import scan, resolve, write_file
+
+scan_result = scan(root=".", recursive=True, detect_optional=True)
+external_names = [r.name for r in scan_result.imports]
+
+resolve_result = resolve(external_names)
+write_file(resolve_result, "requirements.txt")
+```
+
+---
+
+## Publishing to PyPI
+
+```bash
+pip install build twine
+
+# Build
+python -m build
+
+# Upload to TestPyPI first
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+---
+
+## License
+
+[MIT](LICENSE)

reqbuild-0.1.0/README.md

@@ -0,0 +1,167 @@
+# reqbuild
+
+> Automatically generate `requirements.txt` from your Python project using AST analysis — no imports, no installation needed at scan time.
+
+[![PyPI version](https://badge.fury.io/py/reqbuild.svg)](https://pypi.org/project/reqbuild/)
+[![Python](https://img.shields.io/pypi/pyversions/reqbuild.svg)](https://pypi.org/project/reqbuild/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## Features
+
+- 🔍 **AST-based** — parses your source files without running them
+- 🌐 **Smart resolution** — uses the [pipreqs](https://github.com/bndr/pipreqs) mapping + live PyPI fallback
+- 🚫 **Zero dependencies** — only the Python standard library
+- 🔘 **Optional import detection** — spots imports inside `try/except ImportError` blocks
+- 🎛️ **Flexible CLI** — control scope, exclusions, output format, and more
+
+---
+
+## Installation
+
+```bash
+pip install reqbuild
+```
+
+---
+
+## Quick Start
+
+```bash
+# Scan only the current folder
+reqbuild generate
+
+# Scan everything recursively
+reqbuild generate -a
+
+# Preview without writing a file
+reqbuild generate -a --print
+```
+
+---
+
+## CLI Reference
+
+### `reqbuild generate` (alias: `gen`)
+
+Scan Python files and generate a requirements file.
+
+| Flag | Description |
+|------|-------------|
+| `-a`, `--all` | Scan the current folder **and all subdirectories** recursively |
+| `-e DIR` | Exclude a directory name (repeatable: `-e tests -e docs`) |
+| `-ef FILE` | Exclude a specific filename (repeatable: `-ef conftest.py`) |
+| `-o FILENAME` | Output filename (default: `requirements.txt`). Use `.in` for pip-compile |
+| `--print` | Print resolved dependencies to stdout instead of writing a file |
+| `--optional` | Detect imports inside `try/except ImportError` and list them as comments |
+| `--no-network` | Offline mode — skip pipreqs download and PyPI checks |
+| `-h`, `--help` | Show help for this command |
+
+### Global flags
+
+| Flag | Description |
+|------|-------------|
+| `-V`, `--version` | Show the installed version |
+
+---
+
+## Examples
+
+```bash
+# Generate requirements.in (pip-compile compatible)
+reqbuild generate -a -o requirements.in
+
+# Exclude test and docs directories
+reqbuild generate -a -e tests -e docs
+
+# Exclude a specific file
+reqbuild generate -a -ef setup.py
+
+# Detect optional imports (try/except ImportError)
+reqbuild generate -a --optional
+
+# Offline mode (no network calls)
+reqbuild generate -a --no-network
+
+# Preview all dependencies without writing
+reqbuild generate -a --print
+```
+
+---
+
+## Optional import detection
+
+With `--optional`, reqbuild will detect imports wrapped in `try/except ImportError`:
+
+```python
+import requests          # required — goes to requirements.txt
+
+try:
+    import ujson         # optional — listed as a comment
+except ImportError:
+    import json as ujson
+```
+
+Output (`requirements.txt`):
+```
+requests
+
+# ─── Optional dependencies (detected inside try/except ImportError) ───
+# ujson
+```
+
+---
+
+## Default ignored directories
+
+reqbuild automatically ignores:
+
+`.venv`, `venv`, `.env`, `env`, `__pycache__`, `.git`, `.hg`, `.svn`,
+`.tox`, `.nox`, `dist`, `build`, `site-packages`, `.mypy_cache`,
+`.pytest_cache`, `.ruff_cache`, `node_modules`, `.eggs`
+
+Add more with `-e`:
+
+```bash
+reqbuild generate -a -e migrations -e fixtures
+```
+
+---
+
+## Python API
+
+reqbuild can also be used as a library:
+
+```python
+from reqbuild import scan, resolve, write_file
+
+scan_result = scan(root=".", recursive=True, detect_optional=True)
+external_names = [r.name for r in scan_result.imports]
+
+resolve_result = resolve(external_names)
+write_file(resolve_result, "requirements.txt")
+```
+
+---
+
+## Publishing to PyPI
+
+```bash
+pip install build twine
+
+# Build
+python -m build
+
+# Upload to TestPyPI first
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+---
+
+## License
+
+[MIT](LICENSE)

reqbuild-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "reqbuild"
+version = "0.1.0"
+description = "Automatically generate requirements.txt from your Python project using AST analysis."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+keywords = ["requirements", "dependencies", "pip", "packaging", "ast"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+
+# reqbuild has zero runtime dependencies – everything it needs is in the stdlib.
+dependencies = []
+
+[project.scripts]
+reqbuild = "reqbuild.cli:main"
+
+# ─── Optional dev dependencies ────────────────────────────────────────────────
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "hatch",
+    "twine",
+    "build",
+]
+
+# ─── Tool config ─────────────────────────────────────────────────────────────
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]

reqbuild-0.1.0/reqbuild/__init__.py

@@ -0,0 +1,23 @@
+"""
+reqbuild – Automatically generate requirements.txt from your Python project.
+"""
+
+__version__ = "0.1.0"
+__author__ = "reqbuild contributors"
+__license__ = "MIT"
+
+from .scanner import scan, ScanResult, ImportRecord, DEFAULT_IGNORE_DIRS
+from .resolver import resolve, ResolveResult
+from .writer import write_file, print_output
+
+__all__ = [
+    "scan",
+    "resolve",
+    "write_file",
+    "print_output",
+    "ScanResult",
+    "ImportRecord",
+    "ResolveResult",
+    "DEFAULT_IGNORE_DIRS",
+    "__version__",
+]

reqbuild-0.1.0/reqbuild/__main__.py

@@ -0,0 +1,5 @@
+"""Allow running as: python -m reqbuild"""
+import sys
+from .cli import main
+
+sys.exit(main())