easyreqtxt 0.1.0__py3-none-any.whl

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,7 @@
+easyreqtxt/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+easyreqtxt/main.py,sha256=2iLIDUSRuTTapoeJrQLxiOTlF0KbKzBShfiXdsr0w_E,3937
+easyreqtxt-0.1.0.dist-info/METADATA,sha256=OlKEL6gvjOLeSRijrumkbuODGPBhlbBurk_umVhlvZM,1598
+easyreqtxt-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+easyreqtxt-0.1.0.dist-info/entry_points.txt,sha256=IYRg6xWLEXFobcn7WJ8NMhi7WIbG3CXz2s3UQVB78es,52
+easyreqtxt-0.1.0.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+easyreqtxt-0.1.0.dist-info/RECORD,,

easyreqtxt-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

easyreqtxt-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+easyreqtxt = easyreqtxt.main:main

easyreqtxt-0.1.0.dist-info/licenses/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>