pryv.api

This package defines the API controllers.

pryv.api.mount(app)

Mounts the API onto the given Flask instance.

Parameters:app (flask.Flask) – The Flask instance.

pryv.api.simple

This module defines the controller for the simple API. The simple API enables package manager to explore projects in the repository and upload new packages.

See also

PEP 503 – Simple Repository API | Python.org

Official python’s documentation for the simple API.

pryv.api.simple.get_simple_index(*args, **kwargs)

Gets the index of all available projects.

pryv.api.simple.get_simple_project(*args, **kwargs)

Gets the index of a project.

Parameters:project_normalized_name (str) – The normalized project name.

pryv.api.simple.post_simple_index(*args, **kwargs)

Posts a new package.

pryv.api.package

This module defines the controller for the packages API. The packages API enables package managers to download packages from the repository.

pryv.api.package.get_package(*args, **kwargs)

Gets the package with the given name from the project with the given name.

Parameters:package_name (str) – The name of the package.