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, first:

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

And then the normal installation procedure applies:

python -m pip install -e .

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.9.0.tar.gz (700.7 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.9.0-py3-none-any.whl (721.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for simple_repository_browser-0.9.0.tar.gz
Algorithm Hash digest
SHA256 9cb00031c2e1c1dffe3e0d4336f2b8a280050c44d0dd6f9622969d9d363e4096
MD5 8c02efc50b8ea57ffaf27a1bd85829ec
BLAKE2b-256 370e6e1325116b63c6cc13052c144831cda7c1d93fb6d9f844919abf4f3dcdce

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_repository_browser-0.9.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.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_repository_browser-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b0193f90e66397d948232594c5f9741ea958e2e0d09d691bd01c4910119552d
MD5 1773089a4a61f03c75b868c042d57b74
BLAKE2b-256 25f12b576163d6d00240cd6419fd149cffa258f4dc028bcfaa0f50f6605aed29

See more details on using hashes here.

Provenance

The following attestation bundles were made for simple_repository_browser-0.9.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