easyreqtxt 0.1.0__tar.gz

easyreqtxt-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,53 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/easyreqtxt/
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

easyreqtxt-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.pyc
+.venv/
+build/
+dist/
+*.egg-info/
+requirements.txt

easyreqtxt-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

easyreqtxt-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

easyreqtxt-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.5
+Name: easyreqtxt
+Version: 0.1.0
+Summary: Easily make requirements.txt files for entire python projects.
+License-File: LICENSE
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# easyreqtxt
+
+A Python command-line tool that creates `requirements.txt` files by scanning a Python project for its imports.
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cayrrs/easyreqtxt.git
+cd easyreqtxt
+```
+
+Install easyreqtxt:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+Provide the directory you want to scan:
+
+```bash
+easyreqtxt <folder>
+```
+
+For example:
+
+```bash
+easyreqtxt .
+```
+
+This recursively scans the directory for Python files and creates a `requirements.txt` file.
+
+### Custom Output File
+
+Use `-o` or `--output` to specify a different output file:
+
+```bash
+easyreqtxt . -o requirements-dev.txt
+```
+
+## How It Works
+
+easyreqtxt:
+
+1. Recursively finds Python files in the specified directory.
+2. Finds imported modules using Python's AST parser.
+3. Ignores Python standard-library modules.
+4. Resolves imported modules to installed packages.
+5. Retrieves the installed package versions.
+6. Writes the dependencies to the output file.
+
+For example, a project containing:
+
+```python
+import requests
+import numpy
+import json
+```
+
+could produce:
+
+```text
+requests==2.32.5
+numpy==2.3.3
+```
+
+The `json` module is excluded because it is part of Python's standard library.
+
+## Requirements
+
+Python 3.14 or newer.
+
+## License
+
+This project is licensed under the Unlicense (do whatever you want) License. See the [LICENSE](LICENSE) file for details.

easyreqtxt-0.1.0/README.md

@@ -0,0 +1,78 @@
+# easyreqtxt
+
+A Python command-line tool that creates `requirements.txt` files by scanning a Python project for its imports.
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/cayrrs/easyreqtxt.git
+cd easyreqtxt
+```
+
+Install easyreqtxt:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+Provide the directory you want to scan:
+
+```bash
+easyreqtxt <folder>
+```
+
+For example:
+
+```bash
+easyreqtxt .
+```
+
+This recursively scans the directory for Python files and creates a `requirements.txt` file.
+
+### Custom Output File
+
+Use `-o` or `--output` to specify a different output file:
+
+```bash
+easyreqtxt . -o requirements-dev.txt
+```
+
+## How It Works
+
+easyreqtxt:
+
+1. Recursively finds Python files in the specified directory.
+2. Finds imported modules using Python's AST parser.
+3. Ignores Python standard-library modules.
+4. Resolves imported modules to installed packages.
+5. Retrieves the installed package versions.
+6. Writes the dependencies to the output file.
+
+For example, a project containing:
+
+```python
+import requests
+import numpy
+import json
+```
+
+could produce:
+
+```text
+requests==2.32.5
+numpy==2.3.3
+```
+
+The `json` module is excluded because it is part of Python's standard library.
+
+## Requirements
+
+Python 3.14 or newer.
+
+## License
+
+This project is licensed under the Unlicense (do whatever you want) License. See the [LICENSE](LICENSE) file for details.

easyreqtxt-0.1.0/pyproject.toml

@@ -0,0 +1,13 @@
+[project]
+name = "easyreqtxt"
+version = "0.1.0"
+description = "Easily make requirements.txt files for entire python projects."
+readme = "README.md"
+requires-python = ">=3.14"
+
+[project.scripts]
+easyreqtxt = "easyreqtxt.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

easyreqtxt-0.1.0/src/easyreqtxt/main.py

@@ -0,0 +1,124 @@
+import importlib.metadata
+import ast
+import logging
+import sys
+from pathlib import Path
+import argparse
+
+package_map = importlib.metadata.packages_distributions()
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(levelname)s: %(message)s"
+)
+
+logger = logging.getLogger(__name__)
+
+
+modules = []
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Scan a folder for Python imports and resolve their versions, and output them to a requirements.txt"
+    )
+    parser.add_argument(
+        "folder",
+        type=str,
+        help="Path to the folder to scan."
+    )
+    parser.add_argument(
+        "-o", "--output",
+        type=str,
+        default="requirements.txt",
+        help="Output filename (default: requirements.txt)"
+    )
+    return parser.parse_args()
+
+
+
+def walkfile(filepath: Path):
+    filename = filepath.name
+    module_names = []
+    logger.info(f"Beginning walk on {filename}")
+    with open(filepath, 'r',encoding='utf-8') as f:
+        source = f.read()
+    tree = ast.parse(source)
+    walk = (ast.walk(tree))
+    for node in walk:
+        if isinstance(node, ast.Import):
+            for alias in node.names:
+                nm = alias.name.split(".")[0]
+                if nm in module_names:
+                    continue
+                module_names.append(nm)
+                logger.info(f"Found {nm} in {filename}")
+        else:
+            if isinstance(node, ast.ImportFrom):
+                name = node.module.split(".")[0]
+                if name in module_names:
+                    continue
+                module_names.append(name)
+                logger.info(f"Found {name} in {filename}")
+                
+    logger.info(f"Finished dependency walk on {filename}!")
+    logger.info(f"Beginning dist name corrections")
+    for module in module_names:
+        if module in sys.stdlib_module_names:
+            logger.info(f"Skipping baselib module: {module}")
+            continue
+        if module in package_map:
+            distnames = package_map[module]
+            if len(distnames) > 1:
+                logger.warning(f"Module {module} maps to multiple packages. I shall use the first one.")
+            distname = distnames[0]
+            logger.debug(f"{module} -> {distname}")
+            if any(distname in m for m in modules):
+                logger.info(f"Skipping repeated module: {distname}")
+                continue
+            try:
+                version = importlib.metadata.version(distname)
+            except importlib.metadata.PackageNotFoundError as e:
+                logging.warning(f"Unable to obtain a version for module {module}. Reason: {e}")
+                version = None
+            
+            modules.append({distname: version})
+        else:
+            if any(module in m for m in modules):
+                logger.info(f"Skipping repeated module: {module}")
+                continue
+            try:
+                version = importlib.metadata.version(module)
+            except importlib.metadata.PackageNotFoundError as e:
+                logging.warning(f"Unable to obtain a version for module {module}. Reason: {e}. Version number will equal None. This can happen if the module isn't installed.")
+                version = None
+            modules.append({module: version})
+    
+    logger.info(f"Walk of file {filename} finished!")
+
+            
+    
+def output(filename: str):
+    with open(filename, 'w', encoding='utf-8') as f:
+        for m in modules:
+            for name, ver in m.items():
+                if ver == None:
+                    string = f"{name}"
+                else:
+                    string = f"{name}=={ver}"
+                f.write(string + "\n")
+    logger.info(f"Outputted depedency list at {filename}")
+
+            
+def main():
+    args = parse_args()
+    for f in Path(args.folder).rglob("*.py"):
+        walkfile(f)
+    output(args.output)
+
+
+if __name__ == "__main__":
+    main()
+
+    
+

easyreqtxt-0.1.0/test.py

@@ -0,0 +1,3 @@
+from PIL import PaletteFile
+import adbutils
+from pprint import PrettyPrinter

easyreqtxt-0.1.0/test_project/module_a/api_client.py

@@ -0,0 +1,19 @@
+import requests, PIL
+import json
+from bs4 import BeautifulSoup
+import yaml
+from dotenv import load_dotenv
+import os
+
+load_dotenv()
+
+
+def fetch_page(url):
+    response = requests.get(url)
+    soup = BeautifulSoup(response.text, "html.parser")
+    return soup.title.string
+
+
+def load_config(path):
+    with open(path) as f:
+        return yaml.safe_load(f)

easyreqtxt-0.1.0/test_project/module_a/data_model.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel
+import sqlalchemy
+from sqlalchemy.orm import sessionmaker
+import datetime
+
+
+class User(BaseModel):
+    id: int
+    name: str
+    created_at: datetime.datetime
+
+
+engine = sqlalchemy.create_engine("sqlite:///test.db")
+Session = sessionmaker(bind=engine)

easyreqtxt-0.1.0/test_project/module_a/notes.txt

@@ -0,0 +1,3 @@
+TODO: refactor api_client.py to use httpx instead of requests
+TODO: add retry logic to fetch_page
+import requests  <- this line should NOT be picked up, it's inside a .txt file

easyreqtxt-0.1.0/test_project/module_b/image_tools.py

@@ -0,0 +1,18 @@
+from PIL import Image, ImageFilter
+import cv2
+import numpy as np
+import os
+import sys
+
+
+def load_and_blur(path):
+    img = Image.open(path)
+    return img.filter(ImageFilter.BLUR)
+
+
+def load_with_opencv(path):
+    return cv2.imread(path)
+
+
+def to_array(img):
+    return np.array(img)

easyreqtxt-0.1.0/test_project/module_b/plotting.py

@@ -0,0 +1,15 @@
+import matplotlib.pyplot as plt
+import pandas as pd
+import numpy as np
+from pprint import pprint
+
+
+def plot_dataframe(df):
+    fig, ax = plt.subplots()
+    ax.plot(df["x"], df["y"])
+    return fig
+
+
+def summarize(df):
+    pprint(df.describe())
+    return np.mean(df["y"])

easyreqtxt-0.1.0/test_project/module_b/readme.txt

@@ -0,0 +1,2 @@
+Module B handles image processing and plotting utilities.
+Dependencies are managed via pyproject.toml, not this file.

easyreqtxt-0.1.0/test_project/module_c/async_client.py

@@ -0,0 +1,22 @@
+import aiohttp
+import asyncio
+import redis
+import boto3
+from tqdm import tqdm
+
+
+async def fetch_all(urls):
+    async with aiohttp.ClientSession() as session:
+        results = []
+        for url in tqdm(urls):
+            async with session.get(url) as resp:
+                results.append(await resp.text())
+        return results
+
+
+def get_redis_client():
+    return redis.Redis(host="localhost", port=6379)
+
+
+def get_s3_client():
+    return boto3.client("s3")

easyreqtxt-0.1.0/test_project/module_c/web_app.py

@@ -0,0 +1,20 @@
+from flask import Flask, jsonify
+import click
+from rich.console import Console
+from rich.table import Table
+import requests
+
+app = Flask(__name__)
+console = Console()
+
+
+@app.route("/status")
+def status():
+    return jsonify({"status": "ok"})
+
+
+@click.command()
+@click.option("--port", default=5000)
+def run(port):
+    console.print(f"Starting server on port {port}")
+    app.run(port=port)

easyreqtxt-0.1.0/test_project/scripts/config.txt

@@ -0,0 +1,3 @@
+pipeline_version=1.4
+data_source=local
+output_format=csv

easyreqtxt-0.1.0/test_project/scripts/run_pipeline.py

@@ -0,0 +1,16 @@
+from sklearn.linear_model import LinearRegression
+import pandas as pd
+from dotenv import load_dotenv
+import numpy as np
+from pathlib import Path
+
+load_dotenv()
+
+
+def train_model(csv_path):
+    df = pd.read_csv(csv_path)
+    model = LinearRegression()
+    X = np.array(df[["x"]])
+    y = np.array(df["y"])
+    model.fit(X, y)
+    return model

easyreqtxt-0.1.0/test_project/utils/helpers.py

@@ -0,0 +1,22 @@
+import os
+import sys
+import json
+import re
+import numpy as np
+import requests
+from pydantic import BaseModel
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def safe_request(url):
+    try:
+        return requests.get(url, timeout=5)
+    except requests.exceptions.RequestException as e:
+        logger.error(f"Request failed: {e}")
+        return None
+
+
+class Config(BaseModel):
+    debug: bool = False

easyreqtxt-0.1.0/test_project/utils/log.txt

@@ -0,0 +1,3 @@
+[INFO] Test run started
+[INFO] All tests passed
+[WARNING] Deprecation notice: helpers.safe_request will change signature in v2

easyreqtxt-0.1.0/test_project/utils/testing.py

@@ -0,0 +1,16 @@
+import pytest
+import sys
+
+try:
+    import ujson as json_impl
+except ImportError:
+    import json as json_impl
+
+
+def test_something():
+    assert 1 + 1 == 2
+
+
+@pytest.fixture
+def sample_data():
+    return {"key": "value"}

easyreqtxt-0.1.0/uv.lock

@@ -0,0 +1,13 @@
+version = 1
+revision = 3
+requires-python = ">=3.14"
+resolution-markers = [
+    "sys_platform == 'win32'",
+    "sys_platform == 'emscripten'",
+    "sys_platform != 'emscripten' and sys_platform != 'win32'",
+]
+
+[[package]]
+name = "easyreqtxt"
+version = "0.1.0"
+source = { editable = "." }