https://github.com/pypi/conveyor
Conveyor is a small shim to redirect non-canonical Warehouse URLs to their canonical location
https://github.com/pypi/conveyor
Last synced: 4 months ago
JSON representation
Conveyor is a small shim to redirect non-canonical Warehouse URLs to their canonical location
- Host: GitHub
- URL: https://github.com/pypi/conveyor
- Owner: pypi
- Created: 2016-05-05T18:11:23.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T23:08:10.000Z (about 1 year ago)
- Last Synced: 2025-03-28T16:03:38.102Z (10 months ago)
- Language: Python
- Size: 58.6 KB
- Stars: 12
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# conveyor
This project translates the old URL scheme for packages into redirects and serves legacy user documentation.
Canonical data for redirects is pulled from the JSON documents that PyPI serves.
## Tests
### Prerequisites
You'll need `tox` installed and on your path.
```shell
$ pip install --user tox
$ export PATH=$(python -c "import site; import os; print(os.path.join(site.USER_BASE, 'bin'))"):$PATH
```
### Run test suite
```
$ tox
```
## Running
```shell
python3 -m venv .state/venv
.state/venv/bin/pip install -r requirements.txt
export CONVEYOR_ENDPOINT=https://pypi.python.org
export DOCS_BUCKET=pypi-docs
.state/venv/bin/gunicorn -b 127.0.0.1:8000 -k aiohttp.worker.GunicornWebWorker conveyor.app:application
```
## Deployment
Conveyor reads configuration from the environment:
- `CONVEYOR_ENDPOINT`: The host to query for JSON documents, `https://pypi.python.org`
- `DOCS_BUCKET`: The S3 Bucket that hosts user documentation, `pypi-docs`
Currently conveyor for PyPI production and test deploys via cabotage.