/conveyor

Conveyor is a small shim to redirect non-canonical Warehouse URLs to their canonical location

Primary LanguagePython

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.

$ 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

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.