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.toml(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, ...]
1 maintainer
Release files for requirements-detector 1.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| requirements_detector-1.6.0.tar.gz | 16.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| requirements_detector-1.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 37.3 kB
Release files / requirements_detector-1.6.0.tar.gz
| Download URL | requirements_detector-1.6.0.tar.gz |
|---|---|
| Size | 16.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
601a57092f7a25fbbcf0985fbc91f2af64b1f882e951336cd4920ecee8fb03b1
|
|
BLAKE2b-256 checksum How to use checksums |
f6fa6f9194a51dd9d7dac6a01cad7ea1a99e8f2cf8c4badb84e7446c8f4509a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.20
|
Release files / requirements_detector-1.6.0-py3-none-any.whl
| Download URL | requirements_detector-1.6.0-py3-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2f103d23f38a4c5d8f8858cb30c61c4ff1b0567e0315f8fe2b1595aa4e3ae0e8
|
|
BLAKE2b-256 checksum How to use checksums |
14db7ffd0113e60fd2ecd3918800a4e75567749ce5b5a2f31ecf20977bb5ab7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.20
|
