Skip to main content

The core simple repository (PEP-503) interface, including powerful component implementations suitable for use in repository clients and servers

Reason this release was yanked:

No longer functional

Project description

simple-repository

The core simple repository (PEP-503) interface, including powerful component implementations suitable for use in repository clients and servers.

About

The simple-repository core library provides a base SimpleRepository class, with interfaces for each of the endpoints of the PEP-503 simple repository, namely get_project_list and get_project_page. Furthermore, it exposes an interface for resource retrieval (get_resource), offering the possibility to dynamically control the entire repository interaction from tools such as pip.

Subclasses of the SimpleRepository, commonly referred to as repository "components", are free to specialise the repository behaviour according to their function. Components may contain other components, and in doing so, a directed acyclic graph of repositories can be built-up:

example project page

The resulting SimpleRepository allows repository consumers (either clients or servers) to query the "virtual repository" definition as if it were a traditional file or http based repository.

Some of the implemented components in this repository include:

  • HTTPRepository: represents a http-based PEP-503 compatible simple repository
  • LocalRepository: represents a directory containing many project directories, each with its own files/distributions
  • PrioritySelectedProjectsRepository: represents the combination of an ordered set of repositories, merged such that when choosing a project, the first repository to contain the project will be used. This component is designed to mitigate the dependency confusion attack.
  • MetadataInjectorRepository: with the advent of PEP-658, installers no longer need to download the whole distribution in order to determine a project's metadata (e.g. its dependencies). This repository will compute the metadata on the fly by inspecting the distribution (e.g. a wheel). The component allows downstream consumers (both clients and servers) to assume the existence of metadata, even though the originating repository may not itself provide any.
  • AllowListedRepository: represents a repository which only permits projects to be accessed from a defined list of allowed projects.

There are many such components in this library. In the case that a desired component doesn't already exist, implementing a new one is a matter of implementing a small number of methods. The resulting implementations are re-usable, concise, and are easy to validate and test.

Known usage

Here are some of the known uses of the simple-repository core library:

  • simple-repository-server: A tool for running a PEP-503 simple Python package repository, including features such as dist metadata (PEP-658) and JSON API (PEP-691)
  • simple-repository-browser: A web interface to browse and search packages in any simple package repository (PEP-503), inspired by PyPI / warehouse

If you know of other uses of simple-repository, please submit a PR to add them to the list.

License and Support

This code has been released under the MIT license. It is an initial prototype which is developed in-house, and not currently openly developed.

It is hoped that the release of this prototype will trigger interest from other parties that have similar needs. With sufficient collaborative interest there is the potential for the project to be openly developed, and to power Python package repositories across many domains.

Please get in touch at https://github.com/orgs/simple-repository/discussions to share how this project may be useful to you. This will help us to gauge the level of interest and provide valuable insight when deciding whether to commit future resources to the project.

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-0.3.0.tar.gz (99.6 kB view details)

Uploaded Source

Built Distribution

simple_repository-0.3.0-py3-none-any.whl (69.1 kB view details)

Uploaded Python 3

File details

Details for the file simple-repository-0.3.0.tar.gz.

File metadata

  • Download URL: simple-repository-0.3.0.tar.gz
  • Upload date:
  • Size: 99.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for simple-repository-0.3.0.tar.gz
Algorithm Hash digest
SHA256 90628c1a801d236f4ead97d8d5ff6792d5dd3ee05f55952f0883a0ec3a4a871a
MD5 87b4ebd4d7de8fa60ea17ccea841378f
BLAKE2b-256 5bf041d4188dd07633701ff7c2fef06ae8fae23c40d176983ea80d5b40e1697a

See more details on using hashes here.

Provenance

File details

Details for the file simple_repository-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_repository-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce6eeee14b5a1f9cd76d86fee5050f17811f2ab6e1e6bcbcad01430dba89c8bf
MD5 7ff59ba5f922c85eeebf370380f487e7
BLAKE2b-256 23d22e6c77b445f028f01ee95839b2459211c17a61cab01e9b2492fecf6e96c5

See more details on using hashes here.

Provenance

Supported by

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