bd4c7ce578
This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
2.4 KiB
| date | title | slug | sidebar_position | draft | toc | menu | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2021-07-20T00:00:00+00:00 | PyPI Package Registry | pypi | 100 | false | false |
|
PyPI Package Registry
Publish PyPI packages for your user or organization.
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 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