1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
|
%global _empty_manifest_terminate_build 0
Name: python-pip-api
Version: 0.0.30
Release: 1
Summary: An unofficial, importable pip API
License: Apache Software License
URL: http://github.com/di/pip-api
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/69/a2/90dd01b87277ae65a6fb725dae86a039aeb34e24f576600abd0434aa95c4/pip-api-0.0.30.tar.gz
BuildArch: noarch
Requires: python3-pip
%description
<!--- 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.
%package -n python3-pip-api
Summary: An unofficial, importable pip API
Provides: python-pip-api
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-pip-api
<!--- 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.
%package help
Summary: Development documents and examples for pip-api
Provides: python3-pip-api-doc
%description help
<!--- 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.
%prep
%autosetup -n pip-api-0.0.30
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-pip-api -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.30-1
- Package Spec generated
|
