From d4a8172a25af6cfb070bf0b0df615815cff3b8f8 Mon Sep 17 00:00:00 2001 From: emil Date: Wed, 24 Jun 2026 22:51:10 +0000 Subject: [PATCH] GRM-85: docs: add Gitea PyPI registry instructions for pip install --- README.md | 26 +++++++++++++++++++++++++- docs/user/installation.md | 25 ++++++++++++++++++++++++- 2 files changed, 49 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5af3946..a706c96 100644 --- a/README.md +++ b/README.md @@ -92,11 +92,35 @@ source .venv/bin/activate ### Option 2: Via pip (for using GRM without the full repo) +GRM is published to the Gitea PyPI registry at +`https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple`. +The registry is publicly readable — no authentication required to install. + +**Quick install (one-off):** + +```bash +pip install gitea-runner-manager --index-url https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple +``` + +**Persistent configuration (recommended):** + +Add the registry to `~/.pip/pip.conf` so future `pip install` commands find +GRM automatically: + +```ini +[global] +extra-index-url = https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple +``` + +Then install normally: + ```bash pip install gitea-runner-manager ``` -This installs the `grm` CLI and its Python dependencies. Note that the Ansible playbooks and role are bundled with the package, so `grm install` will work out of the box. However, for development or access to Make targets, clone the repository. +This installs the `grm` CLI and its Python dependencies. The Ansible playbooks +and role are bundled with the package, so `grm install` works out of the box. +For development or access to Make targets, clone the repository (Option 1). ### Post-install configuration diff --git a/docs/user/installation.md b/docs/user/installation.md index 6c889ea..d164089 100644 --- a/docs/user/installation.md +++ b/docs/user/installation.md @@ -51,11 +51,34 @@ source .venv/bin/activate ### Method 2: Via pip +GRM is published to the Gitea PyPI registry at +`https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple`. +The registry is publicly readable — no authentication required to install. + +**Quick install (one-off):** + +```bash +pip install gitea-runner-manager --index-url https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple +``` + +**Persistent configuration (recommended):** + +Add the registry to `~/.pip/pip.conf`: + +```ini +[global] +extra-index-url = https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple +``` + +Then install normally: + ```bash pip install gitea-runner-manager ``` -This installs the `grm` CLI and its Python dependencies. The Ansible playbooks and role are bundled with the package, so `grm install` will work out of the box. However, for development or access to Make targets, clone the repository. +This installs the `grm` CLI and its Python dependencies. The Ansible playbooks +and role are bundled with the package, so `grm install` works out of the box. +For development or access to Make targets, clone the repository (Method 1). ### Post-install configuration