117 lines
4.6 KiB
Plaintext
117 lines
4.6 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: requirements-parser
|
|
Version: 0.11.0
|
|
Summary: This is a small Python module for parsing Pip requirement files.
|
|
Home-page: https://github.com/madpah/requirements-parser/#readme
|
|
License: Apache-2.0
|
|
Keywords: Pip,requirements,parse
|
|
Author: Paul Horton
|
|
Author-email: paul@hogr.dev
|
|
Maintainer: Paul Horton
|
|
Maintainer-email: paul@hogr.dev
|
|
Requires-Python: >=3.8,<4.0
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Intended Audience :: Information Technology
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Topic :: Software Development
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Classifier: Topic :: System :: Software Distribution
|
|
Classifier: Typing :: Typed
|
|
Requires-Dist: packaging (>=23.2)
|
|
Requires-Dist: types-setuptools (>=69.1.0)
|
|
Project-URL: Bug Tracker, https://github.com/madpah/requirements-parser/issues
|
|
Project-URL: Documentation, https://requirements-parser.readthedocs.io/
|
|
Project-URL: Repository, https://github.com/madpah/requirements-parser
|
|
Description-Content-Type: text/markdown
|
|
|
|
# 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/
|
|
|