updates
This commit is contained in:
Iliyan Angelov
@@ -0,0 +1,124 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: pip-api
|
||||
Version: 0.0.34
|
||||
Summary: An unofficial, importable pip API
|
||||
Home-page: http://github.com/di/pip-api
|
||||
Author: Dustin Ingram
|
||||
Author-email: di@python.org
|
||||
Classifier: License :: OSI Approved :: Apache Software License
|
||||
Classifier: Programming Language :: Python :: 3 :: Only
|
||||
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
|
||||
Requires-Python: >=3.8
|
||||
Description-Content-Type: text/markdown
|
||||
License-File: LICENSE
|
||||
Requires-Dist: pip
|
||||
|
||||
|
||||
<!--- BADGES: START --->
|
||||
[][#github-license]
|
||||
[][#pypi-package]
|
||||
[][#pypi-package]
|
||||
[][#conda-forge-package]
|
||||
[][#conda-forge-package]
|
||||
[][#conda-forge-feedstock]
|
||||
|
||||
[#github-license]: https://github.com/di/pip-api/blob/master/LICENSE
|
||||
[#pypi-package]: https://pypi.org/project/pip-api/
|
||||
[#conda-forge-package]: https://anaconda.org/conda-forge/pip-api
|
||||
[#conda-forge-feedstock]: https://github.com/conda-forge/pip-api-feedstock
|
||||
<!--- BADGES: END --->
|
||||
|
||||
Since [`pip`](https://pypi.org/p/pip) is a command-line-tool, [it does not have
|
||||
an official, supported, _importable_
|
||||
API](https://pip.pypa.io/en/latest/user_guide/#using-pip-from-your-program).
|
||||
|
||||
However, this does not mean that people haven't tried to `import pip`, usually
|
||||
to end up with much headache when `pip`'s maintainers do routine refactoring.
|
||||
|
||||
## Goal
|
||||
The goal of this project is to provide an importable `pip` API, which is _fully
|
||||
compliant_ with the recommended method of using `pip` from your program.
|
||||
|
||||
How? By providing an importable API that wraps command-line calls to `pip`,
|
||||
this library can be used as a drop-in replacement for existing uses of `pip`'s
|
||||
internal API.
|
||||
|
||||
### Scope
|
||||
This goal means that any new API added here must have the following
|
||||
equivalents:
|
||||
|
||||
- some internal `pip` API (or combination of internal APIs)
|
||||
- some CLI calls (or combination of CLI calls)
|
||||
|
||||
Any functionality that is not currently possible from internal `pip` API or
|
||||
CLI calls is out of scope.
|
||||
|
||||
## Installation
|
||||
|
||||
You can install `pip-api` with either `pip` or with `conda`.
|
||||
|
||||
**With pip**:
|
||||
|
||||
```sh
|
||||
python -m pip install pip-api
|
||||
```
|
||||
|
||||
**With conda**:
|
||||
|
||||
```sh
|
||||
conda install -c conda-forge pip-api
|
||||
```
|
||||
|
||||
## Supported Commands
|
||||
|
||||
Not all commands are supported in all versions of `pip` and on all platforms.
|
||||
If the command you are trying to use is not compatible, `pip_api` will raise a
|
||||
`pip_api.exceptions.Incompatible` exception for your program to catch.
|
||||
|
||||
### Available with all `pip` versions:
|
||||
* `pip_api.version()`
|
||||
> Returns the `pip` version as a string, e.g. `"9.0.1"`
|
||||
|
||||
* `pip_api.installed_distributions(local=False)`
|
||||
> Returns a list of all installed distributions as a `Distribution` object with the following attributes:
|
||||
> * `Distribution.name` (`string`): The name of the installed distribution
|
||||
> * `Distribution.version` ([`packaging.version.Version`](https://packaging.pypa.io/en/latest/version/#packaging.version.Version)): The version of the installed distribution
|
||||
> * `Distribution.location` (`string`): The location of the installed distribution
|
||||
> * `Distribution.editable` (`bool`): Whether the distribution is editable or not
|
||||
> Optionally takes a `local` parameter to filter out globally-installed packages
|
||||
|
||||
* `pip_api.parse_requirements(filename, options=None, include_invalid=False, strict_hashes=False)`
|
||||
> Takes a path to a filename of a Requirements file. Returns a mapping from package name to a `pip_api.Requirement` object (subclass of [`packaging.requirements.Requirement`](https://packaging.pypa.io/en/latest/requirements/#packaging.requirements.Requirement)) with the following attributes:
|
||||
> * `Requirement.name` (`string`): The name of the requirement.
|
||||
> * `Requirement.extras` (`set`): A set of extras that the requirement specifies.
|
||||
> * `Requirement.specifier` ([`packaging.specifiers.SpecifierSet`](https://packaging.pypa.io/en/latest/specifiers/#packaging.specifiers.SpecifierSet)): A `SpecifierSet` of the version specified by the requirement.
|
||||
> * `Requirement.marker` ([`packaging.markers.Marker`](https://packaging.pypa.io/en/latest/markers/#packaging.markers.Marker)): A `Marker` of the marker for the requirement. Can be `None`.
|
||||
> * `Requirement.hashes` (`dict`): A mapping of hashes for the requirement, corresponding to `--hash=...` options.
|
||||
> * `Requirement.editable` (`bool`): Whether the requirement is editable, corresponding to `-e ...`
|
||||
> * `Requirement.filename` (`str`): The filename that the requirement originates from.
|
||||
> * `Requirement.lineno` (`int`): The source line that the requirement was parsed from.
|
||||
>
|
||||
> Optionally takes an `options` parameter to override the regex used to skip requirements lines.
|
||||
> Optionally takes an `include_invalid` parameter to return an `UnparsedRequirement` in the event that a requirement cannot be parsed correctly.
|
||||
> Optionally takes a `strict_hashes` parameter to require that all requirements have associated hashes.
|
||||
|
||||
### Available with `pip>=8.0.0`:
|
||||
* `pip_api.hash(filename, algorithm='sha256')`
|
||||
> Returns the resulting as a string.
|
||||
> Valid `algorithm` parameters are `'sha256'`, `'sha384'`, and `'sha512'`
|
||||
|
||||
### Available with `pip>=19.2`:
|
||||
* `pip_api.installed_distributions(local=False, paths=[])`
|
||||
> As described above, but with an extra optional `paths` parameter to provide a list of locations to look for installed distributions. Attempting to use the `paths` parameter with `pip<19.2` will result in a `PipError`.
|
||||
|
||||
## Use cases
|
||||
This library is in use by a number of other tools, including:
|
||||
* [`pip-audit`](https://pypi.org/project/pip-audit/), to analyze dependencies for known vulnerabilities
|
||||
* [`pytest-reqs`](https://pypi.org/project/pytest-reqs), to compare requirements files with test dependencies
|
||||
* [`hashin`](https://pypi.org/project/hashin/), to add hash pinning to requirements files
|
||||
* ...and many more.
|
||||
Reference in New Issue
Block a user