Python tool to find and list requirements of a Python project
Project description
Requirements Detector
Status
About
requirements-detector is a simple Python tool which attempts to find and list the requirements of a Python project.
When run from the root of a Python project, it will try to ascertain which libraries and the versions of those libraries that the project depends on.
It uses the following methods in order, in the root of the project:
- Parse
setup.py(if this is successful, the remaining steps are skipped) - Parse
pyproject.yoml(if atool.poetry.dependenciessection is found, the remaining steps are skipped) - Parse
requirements.txtorrequirements.pip - Parse all
*.txtand*.pipfiles inside a folder calledrequirements - Parse all files in the root folder matching
*requirements*.txtorreqs.txt(so for example,pip_requirements.txtwould match, as wouldrequirements_common.txt)
Usage
detect-requirements [path]
If path is not specified, the current working directory will be used.
Output
The output will be plaintext, and match that of a pip requirements file, for example:
Django==1.5.2
South>=0.8
anyjson
celery>=2.2,<3
Usage From Python
>>> import os
>>> from requirements_detector import find_requirements
>>> find_requirements(os.getcwd())
[DetectedRequirement:Django==1.5.2, DetectedRequirement:South>=0.8, ...]
If you know the relevant file or directory, you can use from_requirements_txt, from_setup_py or from_requirements_dir directly.
>>> from requirements_detector import from_requirements_txt
>>> from_requirements_txt("/path/to/requirements.txt")
[DetectedRequirement:Django==1.5.2, DetectedRequirement:South>=0.8, ...]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file requirements_detector-1.1.0.tar.gz.
File metadata
- Download URL: requirements_detector-1.1.0.tar.gz
- Upload date:
- Size: 9.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 246bd23867c12061eadb346a6fe2e616f0b64e681936154a76c494a27cda3ea8 |
|
| MD5 | 5461a75d88193f59f5c625e46b139ddf |
|
| BLAKE2b-256 | ede47e5628f1561e5afe99c2f4ed4cd6841f22aafe3a852829a2452dce862933 |
File details
Details for the file requirements_detector-1.1.0-py3-none-any.whl.
File metadata
- Download URL: requirements_detector-1.1.0-py3-none-any.whl
- Upload date:
- Size: 12.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9af62db621c95e0176fed029079924e648de22cd0bb4189c441b9376942faab1 |
|
| MD5 | 097e1e07330a17d44f08ae2950a13a30 |
|
| BLAKE2b-256 | fdcd6070f19404d1d7d336c41dbdaf8fa24304f5becba3033eddbfe51bb0c5e6 |
