Revised installation procedure to not use 'uv init'.

2026-02-14 15:39:28 -05:00
parent 268e3c839a
commit d0be6e6137
+4 -5
@@ -26,18 +26,18 @@ Owlbot's core is a framework for building and running modules. If the included m
### 1. Installation
Create a directory for Owlbot, initialize a uv project, and install the package. This procedure assumes Owlbot is being installed on the same system as Owncast, but this is not a requirement.
Create a directory for Owlbot, set up a virtual environment, and install the package. This procedure assumes Owlbot is being installed on the same system as Owncast, but this is not a requirement.
```bash
mkdir owlbot && cd owlbot
uv init --no-readme
uv add owlbot \
uv venv --python 3.14
uv pip install owlbot \
--default-index https://git.logal.dev/api/packages/LogalDeveloper/pypi/simple/ \
--index https://pypi.org/simple
uv run owlbot init
```
`uv add` installs the correct Python version, creates a virtual environment, and installs all dependencies. `owlbot init` creates a default `config.yaml`. Built-in modules ship with the package and are loaded automatically.
`uv venv` creates a virtual environment with the required Python version, downloading it automatically if needed. `uv pip install` installs Owlbot and all dependencies. `owlbot init` creates a default `config.yaml`. Built-in modules ship with the package and are loaded automatically.
### 2. Access Token
@@ -116,4 +116,3 @@ That's it! Your Owlbot instance is now set up. Check out the pages below to lear
- **[Command Reference](Command-Reference)** - Quick listing of all commands included with the default modules.
- **[Configuration](Configuration)** - All settings, environment variables, and config file options.
- **[Modules](Modules)** - Writing custom modules for Owlbot.