python-auto-req 0.1.0__tar.gz

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

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: ["main", "master"]
+  pull_request:
+    branches: ["main", "master"]
+
+jobs:
+  test:
+    name: "Test Python ${{ matrix.python-version }} / ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package + pytest
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install pytest
+
+      - name: Run tests
+        run: pytest tests/ -v

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

@@ -0,0 +1,101 @@
+name: Publish to PyPI
+
+# Triggers when you push a version tag:  git tag v0.1.0 && git push --tags
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+# Required for PyPI Trusted Publishing (OIDC) – no API token needed.
+permissions:
+  contents: read
+  id-token: write   # allows the job to request an OIDC token from GitHub
+
+jobs:
+  # -------------------------------------------------------------------------
+  # 1. Run the full test suite before publishing
+  # -------------------------------------------------------------------------
+  test:
+    name: "Test before publish"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install package + pytest
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install pytest
+
+      - name: Run tests
+        run: pytest tests/ -v
+
+  # -------------------------------------------------------------------------
+  # 2. Build the distribution
+  # -------------------------------------------------------------------------
+  build:
+    name: "Build distribution"
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade pip hatchling build
+
+      - name: Build wheel + sdist
+        run: python -m build
+
+      - name: Verify tag matches package version
+        # Exits non-zero (fails the build) if the git tag doesn't match
+        # the version declared in pyproject.toml.
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"          # strip leading 'v'
+          PKG=$(python -c "import tomllib; f=open('pyproject.toml','rb'); print(tomllib.load(f)['project']['version'])")
+          echo "Tag version : $TAG"
+          echo "Package version: $PKG"
+          [ "$TAG" = "$PKG" ] || { echo "Version mismatch!"; exit 1; }
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  # -------------------------------------------------------------------------
+  # 3. Publish to PyPI via Trusted Publishing (OIDC – no API token required)
+  #
+  # One-time setup on PyPI:
+  #   1. Go to https://pypi.org/manage/account/publishing/
+  #   2. Add a new "pending publisher":
+  #        PyPI project name : python-auto-req
+  #        GitHub owner      : Amit-Roy
+  #        Repository name   : python-auto-req
+  #        Workflow filename : publish.yml
+  #        Environment name  : pypi   (must match the environment: below)
+  # -------------------------------------------------------------------------
+  publish:
+    name: "Publish to PyPI"
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/project/python-auto-req/
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No 'with: password:' token needed – OIDC handles authentication.

python_auto_req-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+
+# Packaging / build
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Test / coverage
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Type checkers
+.mypy_cache/
+.ruff_cache/
+
+# IDE
+.vscode/
+.idea/
+*.sublime-project
+*.sublime-workspace
+
+# OS
+.DS_Store
+Thumbs.db

python_auto_req-0.1.0/LICENSE

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

python_auto_req-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: python-auto-req
+Version: 0.1.0
+Summary: Scan project source files and populate requirements.txt – with PyPI search and interactive resolution.
+Project-URL: Homepage, https://github.com/Amit-Roy/python-auto-req
+Project-URL: Repository, https://github.com/Amit-Roy/python-auto-req
+Project-URL: Issues, https://github.com/Amit-Roy/python-auto-req/issues
+Author-email: Amit Roy <a.roy.0593@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: dependencies,pypi,requirements,scanner
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatchling; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# python-auto-req
+
+Scan your Python project's `.py` and `.ipynb` files, discover every third-party
+package that is actually **imported**, and add them to `requirements.txt`.
+
+> **Only packages explicitly referenced in your source files are considered.**
+> Packages installed in `.venv` but never imported are ignored.
+
+---
+
+## Features
+
+- Recursively scans `.py` and `.ipynb` files (skips `.venv`, `.git`, `__pycache__`, etc.)
+- Uses the active Python environment to resolve module → distribution name + version
+- Falls back to a **live PyPI search** for unknown modules with an interactive menu:
+  - Pick from top-5 results ranked by n-gram similarity
+  - Auto-select top match (`[a]` or `--auto`)
+  - Enter a name manually (`[m]`)
+  - Skip (`[s]`) or quit (`[q]`)
+- Offers to run `pip install -r requirements.txt` after writing
+
+---
+
+## Installation
+
+```bash
+pip install python-auto-req
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/Amit-Roy/python-auto-req
+cd python-auto-req
+pip install -e .
+```
+
+---
+
+## Usage
+
+```bash
+# Preview what would be added (dry-run, interactive)
+auto-req
+
+# Write requirements.txt
+auto-req --dry-run 0
+
+# Write requirements.txt, auto-pick top PyPI match for unknowns
+auto-req --dry-run 0 --auto
+
+# Scan a specific directory
+auto-req --dir /path/to/project --dry-run 0
+```
+
+Or via Python:
+
+```bash
+python -m auto_req --dry-run 0
+```
+
+### CLI options
+
+| Option | Default | Description |
+|---|---|---|
+| `--dry-run 0\|1` | `1` | `1` = preview only; `0` = write to file |
+| `--auto` | off | Always pick the top PyPI match (no prompts) |
+| `--dir DIR` | `.` | Project root to scan |
+| `--requirements FILE` | `./requirements.txt` | Path to requirements.txt |
+
+---
+
+## Interactive resolution example
+
+```
+  Unrecognised module: 'yfinance'
+  Searching PyPI for 'yfinance'... 5 result(s).
+  Top PyPI matches:
+    [1] yfinance       (similarity 1.00)
+    [2] yfinance-cache (similarity 0.78)
+    [3] yfinance-ez    (similarity 0.72)
+    ...
+
+  [1-5] select a match above
+  [a]   auto-select top match for ALL remaining unknowns
+  [m]   enter the correct dist name manually
+  [s]   skip  (omit from requirements, continue)
+  [q]   quit  (stop resolution now)
+
+  Your choice: 1
+```
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## Publishing to PyPI
+
+Publishing is handled automatically by GitHub Actions ([.github/workflows/publish.yml](.github/workflows/publish.yml)) whenever you push a version tag.
+
+### One-time PyPI Trusted Publisher setup
+
+1. Go to <https://pypi.org/manage/account/publishing/>
+2. Add a **pending publisher** with:
+   - **PyPI project name**: `python-auto-req`
+   - **GitHub owner**: `Amit-Roy`
+   - **Repository name**: `python-auto-req`
+   - **Workflow filename**: `publish.yml`
+   - **Environment name**: `pypi`
+3. On GitHub, create a repository **Environment** named `pypi`  
+   *(Settings → Environments → New environment)*
+
+### Releasing a new version
+
+```bash
+# 1. Bump the version in pyproject.toml (and src/auto_req/__init__.py)
+# 2. Commit and push
+git add pyproject.toml src/auto_req/__init__.py
+git commit -m "chore: release v0.2.0"
+git push
+
+# 3. Tag and push – this triggers the publish workflow
+git tag v0.2.0
+git push --tags
+```
+
+The workflow will:
+1. Run the full test matrix
+2. Build wheel + sdist
+3. Verify the tag matches the package version
+4. Publish to PyPI via OIDC (no API token required)
+
+### Local build (optional)
+
+```bash
+pip install -e ".[dev]"
+python -m build
+```
+
+MIT

python_auto_req-0.1.0/README.md

@@ -0,0 +1,147 @@
+# python-auto-req
+
+Scan your Python project's `.py` and `.ipynb` files, discover every third-party
+package that is actually **imported**, and add them to `requirements.txt`.
+
+> **Only packages explicitly referenced in your source files are considered.**
+> Packages installed in `.venv` but never imported are ignored.
+
+---
+
+## Features
+
+- Recursively scans `.py` and `.ipynb` files (skips `.venv`, `.git`, `__pycache__`, etc.)
+- Uses the active Python environment to resolve module → distribution name + version
+- Falls back to a **live PyPI search** for unknown modules with an interactive menu:
+  - Pick from top-5 results ranked by n-gram similarity
+  - Auto-select top match (`[a]` or `--auto`)
+  - Enter a name manually (`[m]`)
+  - Skip (`[s]`) or quit (`[q]`)
+- Offers to run `pip install -r requirements.txt` after writing
+
+---
+
+## Installation
+
+```bash
+pip install python-auto-req
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/Amit-Roy/python-auto-req
+cd python-auto-req
+pip install -e .
+```
+
+---
+
+## Usage
+
+```bash
+# Preview what would be added (dry-run, interactive)
+auto-req
+
+# Write requirements.txt
+auto-req --dry-run 0
+
+# Write requirements.txt, auto-pick top PyPI match for unknowns
+auto-req --dry-run 0 --auto
+
+# Scan a specific directory
+auto-req --dir /path/to/project --dry-run 0
+```
+
+Or via Python:
+
+```bash
+python -m auto_req --dry-run 0
+```
+
+### CLI options
+
+| Option | Default | Description |
+|---|---|---|
+| `--dry-run 0\|1` | `1` | `1` = preview only; `0` = write to file |
+| `--auto` | off | Always pick the top PyPI match (no prompts) |
+| `--dir DIR` | `.` | Project root to scan |
+| `--requirements FILE` | `./requirements.txt` | Path to requirements.txt |
+
+---
+
+## Interactive resolution example
+
+```
+  Unrecognised module: 'yfinance'
+  Searching PyPI for 'yfinance'... 5 result(s).
+  Top PyPI matches:
+    [1] yfinance       (similarity 1.00)
+    [2] yfinance-cache (similarity 0.78)
+    [3] yfinance-ez    (similarity 0.72)
+    ...
+
+  [1-5] select a match above
+  [a]   auto-select top match for ALL remaining unknowns
+  [m]   enter the correct dist name manually
+  [s]   skip  (omit from requirements, continue)
+  [q]   quit  (stop resolution now)
+
+  Your choice: 1
+```
+
+---
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## Publishing to PyPI
+
+Publishing is handled automatically by GitHub Actions ([.github/workflows/publish.yml](.github/workflows/publish.yml)) whenever you push a version tag.
+
+### One-time PyPI Trusted Publisher setup
+
+1. Go to <https://pypi.org/manage/account/publishing/>
+2. Add a **pending publisher** with:
+   - **PyPI project name**: `python-auto-req`
+   - **GitHub owner**: `Amit-Roy`
+   - **Repository name**: `python-auto-req`
+   - **Workflow filename**: `publish.yml`
+   - **Environment name**: `pypi`
+3. On GitHub, create a repository **Environment** named `pypi`  
+   *(Settings → Environments → New environment)*
+
+### Releasing a new version
+
+```bash
+# 1. Bump the version in pyproject.toml (and src/auto_req/__init__.py)
+# 2. Commit and push
+git add pyproject.toml src/auto_req/__init__.py
+git commit -m "chore: release v0.2.0"
+git push
+
+# 3. Tag and push – this triggers the publish workflow
+git tag v0.2.0
+git push --tags
+```
+
+The workflow will:
+1. Run the full test matrix
+2. Build wheel + sdist
+3. Verify the tag matches the package version
+4. Publish to PyPI via OIDC (no API token required)
+
+### Local build (optional)
+
+```bash
+pip install -e ".[dev]"
+python -m build
+```
+
+MIT

python_auto_req-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-auto-req"
+version = "0.1.0"
+description = "Scan project source files and populate requirements.txt – with PyPI search and interactive resolution."
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "Amit Roy", email = "a.roy.0593@gmail.com" }]
+requires-python = ">=3.10"
+keywords = ["requirements", "dependencies", "pypi", "scanner"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "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 :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+# No runtime dependencies – only stdlib is used.
+dependencies = []
+
+[project.optional-dependencies]
+dev = ["pytest", "build", "hatchling", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/Amit-Roy/python-auto-req"
+Repository = "https://github.com/Amit-Roy/python-auto-req"
+Issues = "https://github.com/Amit-Roy/python-auto-req/issues"
+
+[project.scripts]
+auto-req = "auto_req.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/auto_req"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"

python_auto_req-0.1.0/src/auto_req/__init__.py

@@ -0,0 +1,16 @@
+"""python-auto-req – scan project files and populate requirements.txt."""
+
+from .scanner import collect_imports, imports_from_source, imports_from_notebook, stdlib_module_names
+from .resolver import resolve_all, resolve_from_env, search_pypi, ngram_score
+
+__version__ = "0.1.0"
+__all__ = [
+    "collect_imports",
+    "imports_from_source",
+    "imports_from_notebook",
+    "stdlib_module_names",
+    "resolve_all",
+    "resolve_from_env",
+    "search_pypi",
+    "ngram_score",
+]

python_auto_req-0.1.0/src/auto_req/__main__.py

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