Skip to main content

Python tool to find and list requirements of a Python project

Project description

Requirements Detector

Status

Latest Version Build Satus Health Coverage Status Documentation

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:

  1. Parse setup.py (if this is successful, the remaining steps are skipped)
  2. Parse pyproject.toml (if a tool.poetry.dependencies section is found, the remaining steps are skipped)
  3. Parse requirements.txt or requirements.pip
  4. Parse all *.txt and *.pip files inside a folder called requirements
  5. Parse all files in the root folder matching *requirements*.txt or reqs.txt (so for example, pip_requirements.txt would match, as would requirements_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, ...]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

requirements_detector-1.4.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

requirements_detector-1.4.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file requirements_detector-1.4.0.tar.gz.

File metadata

  • Download URL: requirements_detector-1.4.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for requirements_detector-1.4.0.tar.gz
Algorithm Hash digest
SHA256 0326c39269d87504c0e1b75932b86a6fdaa8a9eb3ce82243e5a21b696c2ade76
MD5 0a442a18f77a3bc7e3dd04f39ff0885c
BLAKE2b-256 fb28ba8a796b45f85b30522ecfcde0045e24f83dca4fec1825623978cb527652

See more details on using hashes here.

File details

Details for the file requirements_detector-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for requirements_detector-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d76592a688e2f4553e6d1eb95ac3be0ec105549bc21348712aa12d714c1cd28f
MD5 b3c84221dc920edd60c1d5839369b62a
BLAKE2b-256 208816e2e64fc9b2244ae1132f09770fa367bdf3d3d8538cedf6149dedbefe91

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page