2022-03-30 16:42:47 +08:00
---
date: "2021-07-20T00:00:00+00:00"
2023-05-24 14:21:39 +08:00
title: "PyPI Package Registry"
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00
slug: "pypi"
2023-07-26 12:53:13 +08:00
sidebar_position: 100
2022-03-30 16:42:47 +08:00
draft: false
toc: false
menu:
sidebar:
parent: "packages"
name: "PyPI"
2023-07-26 12:53:13 +08:00
sidebar_position: 100
2022-03-30 16:42:47 +08:00
identifier: "pypi"
---
2023-05-24 14:21:39 +08:00
# PyPI Package Registry
2022-03-30 16:42:47 +08:00
Publish [PyPI ](https://pypi.org/ ) packages for your user or organization.
## Requirements
To work with the PyPI package registry, you need to use the tools [pip ](https://pypi.org/project/pip/ ) to consume and [twine ](https://pypi.org/project/twine/ ) to publish packages.
## Configuring the package registry
To register the package registry you need to edit your local `~/.pypirc` file. Add
```ini
[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. |
2023-07-26 12:53:13 +08:00
| `password` | Your Gitea password. If you are using 2FA or OAuth use a [personal access token ](development/api-usage.md#authentication ) instead of the password. |
2022-03-30 16:42:47 +08:00
## Publish a package
Publish a package by running the following command:
```shell
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:
```shell
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:
```shell
pip install --index-url https://testuser:password123@gitea.example.com/api/packages/testuser/pypi/simple --no-deps test_package
```
2023-01-27 22:12:18 +08:00
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.
2022-03-30 16:42:47 +08:00
## Supported commands
```
pip install
twine upload
2022-07-28 09:22:47 +08:00
```
