Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/madpah/requirements-parser
A Pip requirements file parser.
https://github.com/madpah/requirements-parser
pip
Last synced: 3 days ago
JSON representation
A Pip requirements file parser.
- Host: GitHub
- URL: https://github.com/madpah/requirements-parser
- Owner: madpah
- License: apache-2.0
- Created: 2012-11-24T07:39:03.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T13:38:44.000Z (2 months ago)
- Last Synced: 2024-12-14T16:01:59.140Z (10 days ago)
- Topics: pip
- Language: Python
- Homepage: https://requirements-parser.readthedocs.io
- Size: 309 KB
- Stars: 128
- Watchers: 3
- Forks: 42
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Requirements Parser
[![shield_pypi-version]][link_pypi]
[![shield_rtfd]][link_rtfd]
[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_license]][license_file]
---
This is a small Python module for parsing [Pip](http://www.pip-installer.org/) requirement files.
The goal is to parse everything in the [Pip requirement file format](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-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.
``` {.python}
>>> 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][link_rtfd].
## Python Support
We endeavour to support all functionality for all [current actively supported Python versions](https://www.python.org/downloads/).
However, some features may not be possible/present in older Python versions due to their lack of support.
## Changelog
See our [CHANGELOG][chaneglog_file].
## Contributing
Feel free to open issues, bugreports or pull requests.
See the [CONTRIBUTING][contributing_file] file for details.
## Copyright & License
`requirements-parser` was originally written by @davidfischer and is now maintained by @madpah. See [Authors][authors_file] for full details.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license.
See the [LICENSE][license_file] file for the full license.
[authors_file]: https://github.com/madpah/requirements-parser/blob/main/AUTHORS.md
[license_file]: https://github.com/madpah/requirements-parser/blob/main/LICENSE
[chaneglog_file]: https://github.com/madpah/requirements-parser/blob/main/CHANGELOG.md
[contributing_file]: https://github.com/madpah/requirements-parser/blob/main/CONTRIBUTING.md
[shield_gh-workflow-test]: https://img.shields.io/github/actions/workflow/status/madpah/requirements-parser/poetry.yml?branch=main&logo=GitHub&logoColor=white "build"
[shield_pypi-version]: https://img.shields.io/pypi/v/requirements-parser?logo=pypi&logoColor=white&label=PyPI "PyPI"
[shield_rtfd]: https://img.shields.io/readthedocs/requirements-parser?logo=readthedocs&logoColor=white "Read the Docs"
[shield_license]: https://img.shields.io/github/license/madpah/requirements-parser?logo=open%20source%20initiative&logoColor=white "license"
[link_gh-workflow-test]: https://github.com/madpah/requirements-parser/actions/workflows/poetry.yml?query=branch%3Amain
[link_pypi]: https://pypi.org/project/requirements-parser/
[link_rtfd]: https://requirements-parser.readthedocs.io/en/latest/