From da3e325be133f0ee39f50be833da7966a409fa54 Mon Sep 17 00:00:00 2001 From: Slawomir Koszewski Date: Sun, 6 Sep 2026 19:41:32 +0200 Subject: [PATCH] docs: add installation and publishing instructions for Gitea package registry --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index bc7f884..2f55768 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,38 @@ From outside the checkout, point `PYTHONPATH` at it: PYTHONPATH=/path/to/mailinabox python3 -m mailinabox.cli.miab --help ``` +### Install from the Gitea package registry + +```sh +pip install --index-url https://:@/api/packages//pypi/simple mailinabox +``` + +> **Note** `python-helpers` is resolved from the same registry. If it is published elsewhere, +> install it first and add `--no-deps` here. + +## Publishing + +Add the registry to `~/.pypirc`: + +``` +[distutils] +index-servers = gitea + +[gitea] +repository = https:///api/packages//pypi +username = +password = +``` + +```sh +pip install build twine +python3 -m build +python3 -m twine upload --repository gitea dist/* +``` + +> **Note** a name and version already in the registry cannot be republished. Raise `version` +> in `pyproject.toml` before each upload. + ## Library ```python