Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ammaryasirnaich/pyreqify
This project is a lightweight Python module designed to generate the reqirements.txt file. It streamline dependency management by automatically extracting imported modules from python or juypter files and generating there requirements.txt
https://github.com/ammaryasirnaich/pyreqify
dependency environment extract-data jupyter-notebooks pip project-setup python requirements-generator requirements-txt version
Last synced: about 1 month ago
JSON representation
This project is a lightweight Python module designed to generate the reqirements.txt file. It streamline dependency management by automatically extracting imported modules from python or juypter files and generating there requirements.txt
- Host: GitHub
- URL: https://github.com/ammaryasirnaich/pyreqify
- Owner: ammaryasirnaich
- License: mit
- Created: 2024-11-08T17:17:49.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-10T15:35:35.000Z (2 months ago)
- Last Synced: 2024-12-10T00:54:26.250Z (about 1 month ago)
- Topics: dependency, environment, extract-data, jupyter-notebooks, pip, project-setup, python, requirements-generator, requirements-txt, version
- Language: Python
- Homepage:
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PyReqify
[](https://www.python.org/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/ammaryasirnaich/PyReqify)
A lightweight Python module for `requirements.txt generation`. It efficiently extracts imported modules and generates a `requirements.txt` file with module versions for `.py` and `.ipynb` files in a given directory. Simplify dependency management for your projects!
## Features
- 📦 **Automatic Module Extraction**: Scans `.py` and `.ipynb` files in a directory to find all imported modules.
- 🔍 **Version Detection**: Fetches installed versions of imported modules (maps common aliases to official package names). It also gives the option to includes fetch `source python version` too.
- 📝 **Requirements Generation**: Creates a `requirements.txt` file with all extracted dependencies and the current Python version.
## Installation
Clone this repository and install the requirements.
```bash
pip install pyreqify
```
# ExtractPackages
## Usage
To use the `pyreqify` function and automatically create a `requirements.txt` file:
1. Place all `.py` and `.ipynb` files in a folder (e.g., `project`).
2. Run the function, which will generate a `requirements.txt` in the current directory with all extracted dependencies.
```python
pyreqify --include-source-pyversion
```
##### generated requirement.txt file
```
scikit-learn==1.5.1
keras==3.6.0
numpy==2.0.1
pandas==2.2.2
open3d==0.16.1
webcolors==24.8.0
nbformat==5.10.4
matplotlib==3.9.1
typing==3.7.4.3
torch==2.2.2
python==3.10.14
```
#### Examples
Example 1: Generate `requirements.txt` in the current working folder `without the Python version`.
```python
pyreqify ~/Workspace/project .
```
Example 2: Generate `requirements.txt` in the `deploy folder`, including the `Python version` in the file.
```python
pyreqify ~/Workspace/project ~/Workspace/project/deploy --include-source-pyversion
```