https://github.com/torxed/python-pypiapi
Python library to interact with the pypi.org simple API
https://github.com/torxed/python-pypiapi
Last synced: 9 months ago
JSON representation
Python library to interact with the pypi.org simple API
- Host: GitHub
- URL: https://github.com/torxed/python-pypiapi
- Owner: Torxed
- License: mit
- Created: 2021-06-02T15:21:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-02T13:52:58.000Z (about 3 years ago)
- Last Synced: 2025-01-25T17:11:23.498Z (11 months ago)
- Language: Python
- Size: 58.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-pypiapi
Python library to interact with the pypi.org simple API defined in [PEP-503](https://www.python.org/dev/peps/pep-0503/).
# Usage
Simplest usage would be to use pypi as a module.
## CLI
This example will download 3 versions of everything available on pypi.org for architectures matching `x86_64` and packages marked as `any` *(or `None` defined)*.
```bash
$ python -m pypiapi --tls --cache-listing --retain-versions 3 --architectures 'x86_64,any' --paralell-downloads 3
````
And as per usual, `python -m pypiapi --help` to see what the parameters do.
## Library/Scripting
The following example filters out three libraries and download them one version at a time.
This example relies on manually downloading each package, giving full control of how and when certain packages are downloaded.
```python
import pypiapi
for package in pypiapi.PackageListing({"archinstall" : True, "psycopg2" : True, "pypiapi" : True}):
for version in package.versions():
package.download(version, force=True)
```
The next example grabs the same packages, but does so fully automated and as efficiently as possible.
```python
import pypiapi
pypiapi.PackageListing({"archinstall" : True, "psycopg2" : True, "pypiapi" : True}).download()
```
Third and last example will download all available verions of all packages defined on pypi.org.
The script also has to be called with `--retain-versions=''` to override the default 3-latest-versions policy.
```python
import pypiapi
pypiapi.PackageListing().download()
```
# Parameters/flags
`pypiapi` supports a couple of parameters independent of how you choose to script your downloads.
These flags are as follows:
```
--mirror='pypi.org'
Defines the hostname for the package database to sync from.
pypi.org is the default value as it's the official URL for Python packages.
--port=443
We default to port 443 and --tls as we prefer integrity checks.
--tls
We default to port 443 and --tls.
To turn it off, you need to do --tls='' to override tls.
--simple-api='/simple'
This is the URL to the "simple api", aka directory listing of the packages.
Each package needs to be wrapped in package name\n for this lib to work.
--json-api='/pypi'
This is the JSON api, we'll call this API endpoint followed by package name and /json.
One example would be: /pypi/archinstall/json
--retain-versions=3
How many versions of a package should we download/keep, given the --sort-algorithm used.
This option can be overridden with --retain-versions='' but should generally not be to save
some bandwidth of pypi.org but also yourself. Saves everyone a bunch of time to keep it default.
--sort-algorithm='LooseVersion'
This tells us how to sort the version numbers. Since version naming convention isn't really
strict, we default to LooseVersion which allows for version to end in a string, ex: 1.0b
--destination='./cache'
Where to download the packages when we grab them.
Each package will get its own folder under this destination.
Ex: archinstall would be downloaded to ./cache/archinstall/archinstall-.tar.gz
--timeout=5
If the webserver timeouts on giving us the package listing (it can be quite large).
This will tell the library how long to wait for more packages listing to be streamed to us.
The default is 5 seconds, if we haven't recieved more package names by then, we abort.
--cache-listing
`PackageListing()` in this library supports iterating over it, if iterated multiple times
this flag will simply allow it to not fetch a new package listing again. It will cache
whatever package names were given during initation, and the second iteration of `PackageListing()`
will simply iterate over the cache instead. This speeds up the process quite a bit the second time around.
Has to be overridden with --cache-listing='' if you wish to turn it off.
--py-version=3.10
This tells the downloader what package criterie needs to be met.
The package needs to support the given Python version to be downloaded unless force=True.
This used to be --py-versions and you used to be able to supply multiple and complex patterns, see issue:
https://github.com/pypa/packaging/issues/591
--licenses=[gpl[,mit]]
Only packages that contain the given licensing short names will be downloaded.
The default is to download all libraries/packages.
```