Skip to main content

This is a small Python module for parsing Pip requirement files.

Project description

Requirements Parser

shield_pypi-version shield_rtfd shield_gh-workflow-test shield_license


This is a small Python module for parsing Pip requirement files.

The goal is to parse everything in the Pip requirement file format spec.

Installation

pip install requirements-parser

or

poetry add requirements-parser

Examples

requirements-parser can parse a file-like object or a text string.

>>> import requirements
>>> with open('requirements.txt', 'r') as fd:
...     for req in requirements.parse(fd):
...         print(req.name, req.specs)
Django [('>=', '1.11'), ('<', '1.12')]
six [('==', '1.10.0')]

It can handle most (if not all) of the options in requirement files that do not involve traversing the local filesystem. These include:

  • editables (-e git+https://github.com/toastdriven/pyelasticsearch.git]{.title-ref})
  • version control URIs
  • egg hashes and subdirectories ([\#egg=django-haystack&subdirectory=setup]{.title-ref})
  • extras ([DocParser[PDF]]{.title-ref})
  • URLs

Documentation

View the documentation here.

Python Support

We endeavour to support all functionality for all current actively supported Python versions. However, some features may not be possible/present in older Python versions due to their lack of support.

Changelog

See our CHANGELOG.

Contributing

Feel free to open issues, bugreports or pull requests.
See the CONTRIBUTING file for details.

Copyright & License

requirements-parser was originally written by @davidfischer and is now maintained by @madpah. See Authors for full details.

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.

See the LICENSE file for the full license.

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_parser-0.10.2.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

requirements_parser-0.10.2-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file requirements_parser-0.10.2.tar.gz.

File metadata

  • Download URL: requirements_parser-0.10.2.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for requirements_parser-0.10.2.tar.gz
Algorithm Hash digest
SHA256 ce58a31dd0405413a6e1233bda5ea2667a7ec838679f65055eca75bc5ddb8e70
MD5 d8f40a912c8580fdf24d7f5377025a7f
BLAKE2b-256 7cd7f318dee799be755ad35780e024098ff1b9933f50daee98738c1390fa763e

See more details on using hashes here.

File details

Details for the file requirements_parser-0.10.2-py3-none-any.whl.

File metadata

File hashes

Hashes for requirements_parser-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c55ad80ed7c441fabaaad563931dc4538027989b81be698780a43f1c9fa1c2b2
MD5 d2933ed64c4a19cc41bbf5175f156ecc
BLAKE2b-256 cbecfc51c0e1ede4e7f5c8c84dd52fe413c6374a515f1fddc8677a00588647de

See more details on using hashes here.

Supported by

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