Skip to main content

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

Project description

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:

homepage screenshot

Search:

search result

Project page:

example 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_repository_browser-0.10.0.tar.gz (704.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_repository_browser-0.10.0-py3-none-any.whl (725.0 kB view details)

Uploaded Python 3

File details

Details for the file simple_repository_browser-0.10.0.tar.gz.

File metadata

File hashes

Hashes for simple_repository_browser-0.10.0.tar.gz
Algorithm Hash digest
SHA256 a43b6e4d69231b5d6dcd911c88f79b24e689001a96daee129a1fe72492aa505b
MD5 dea0eba49830552031134a912b19e602
BLAKE2b-256 9a8921594ad2572fa9e111c18141ffc43900d96df51ef8bc3bbce6bf54f71555

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_repository_browser-0.10.0.tar.gz:

Publisher: python-publish.yml on simple-repository/simple-repository-browser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file simple_repository_browser-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_repository_browser-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 148ebfbfe9dcb4224e8ae6b0ca5ca1a6363107b8decaaacfbadfb52ba8888e7e
MD5 53921957921f635e386a7e37e795735d
BLAKE2b-256 00d8bd4e354bd64beef5073fa87886a0fdf18617563b6b3913f6e5d7fa19976b

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_repository_browser-0.10.0-py3-none-any.whl:

Publisher: python-publish.yml on simple-repository/simple-repository-browser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page