e8433b7fe6
- **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2.5 KiB
| date | title | slug | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-07-20T00:00:00+00:00 | PyPI Packages Repository | usage/packages/pypi | false | false |
|
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. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. |
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
You can use --extra-index-url instead of --index-url but that makes you vulnerable to dependency confusion attacks because pip checks the official PyPi repository for the package before it checks the specified custom repository. Read the pip docs for more information.
Supported commands
pip install
twine upload