forgejo/docs/content/doc/packages/pypi.en-us.md

date	title	slug	draft	toc	menu
2021-07-20T00:00:00+00:00	PyPI Packages Repository	packages/pypi	false	false	sidebar parent name weight identifier packages PyPI 80 pypi

PyPI Packages Repository

Publish PyPI packages for your user or organization.

Table of Contents

{{< toc >}}

Requirements

To work with the PyPI package registry, you need to use the tools pip to consume and twine to publish packages.

Configuring the package registry

To register the package registry you need to edit your local ~/.pypirc file. Add

[distutils]
index-servers = gitea

[gitea]
repository = https://gitea.example.com/api/packages/{owner}/pypi
username = {username}
password = {password}

Placeholder	Description
owner	The owner of the package.
username	Your Gitea username.
password	Your Gitea password or a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).

Publish a package

Publish a package by running the following command:

python3 -m twine upload --repository gitea /path/to/files/*

The package files have the extensions .tar.gz and .whl.

You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.

Install a package

To install a PyPI package from the package registry, execute the following command:

pip install --index-url https://{username}:{password}@gitea.example.com/api/packages/{owner}/pypi/simple --no-deps {package_name}

Parameter	Description
username	Your Gitea username.
password	Your Gitea password or a personal access token.
owner	The owner of the package.
package_name	The package name.

For example:

pip install --index-url https://testuser:password123@gitea.example.com/api/packages/testuser/pypi/simple --no-deps test_package

Supported commands

pip install
twine upload