simple-repository-browser 0.12.0

A web interface to browse and search packages in any simple package repository (PEP-503), inspired by PyPI / warehouse

simple-repository-browser

A web interface to browse and search packages in any simple package repository (PEP-503), inspired by PyPI / warehouse.

Built using FastAPI and the simple-repository core library.

Demo

A tech-preview demo is available at https://simple-repository.app.cern.ch/.

Usage

Install from PyPI:

python -m pip install simple-repository-browser

And run:

simple-repository-browser

(or alternatively python -m simple_repository_browser)

By default, this will use the repository at PyPI (https://pypi.org/simple/). You can point it to a custom repository by passing the URL to the project list endpoint (the base URL according to PEP-503):

simple-repository-browser https://my-custom-repository.example.com/foo/simple/

Screenshots

Homepage:

Search:

Project page:

Runtime details

simple-repository-browser exposes a FastAPI application, and it runs the application in a single uvicorn worker. Metadata that is computed will be cached in the $XDG_CACHE_DIR/simple-repository-browser directory. This cache is not intended to be shared among different repository URLs, and is unlikely to work for multiple simple-repository-browser versions. There is currently no intelligent cache invalidation for those cases.

Development

In order to build the simple-repository-browser you will need access to npm. If not available on the development host, you can do it in a docker container first:

docker run --rm -v $PWD:/workdir -it node bash
cd /workdir

Bundle the web app:

cd web
npm install --include=dev
npm run build
cd ..

And then the normal installation procedure applies:

python -m pip install -e .

You may want to disable the indexing to avoid long-running tasks during the development:

export DISABLE_REPOSITORY_INDEXING=1

The browser can be run with:

python -m simple_repository_browser