aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/usage/packages/pypi.en-us.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/usage/packages/pypi.en-us.md')
-rw-r--r--docs/content/usage/packages/pypi.en-us.md84
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/content/usage/packages/pypi.en-us.md b/docs/content/usage/packages/pypi.en-us.md
new file mode 100644
index 0000000000..be59df0762
--- /dev/null
+++ b/docs/content/usage/packages/pypi.en-us.md
@@ -0,0 +1,84 @@
+---
+date: "2021-07-20T00:00:00+00:00"
+title: "PyPI Package Registry"
+slug: "pypi"
+sidebar_position: 100
+draft: false
+toc: false
+menu:
+ sidebar:
+ parent: "packages"
+ name: "PyPI"
+ sidebar_position: 100
+ identifier: "pypi"
+---
+
+# PyPI Package Registry
+
+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. |
+| `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. |
+
+## 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
+```
+
+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
+```