From 37704505b03265f84c18ea3d043e05f61b600090 Mon Sep 17 00:00:00 2001 From: Michael Granitzer Date: Mon, 05 Jan 2026 13:45:09 +0000 Subject: [PATCH] chore: release v4.0.3 with improved install script and docs --- pyproject.toml | 2 +- owilix/_version.py | 4 ++-- docs/source/install.md | 44 +++++++++++++++++++++++++++++++++++++++----- 3 file(s) changed, 42 insertion(s)(+), 8 deletion(s)(-) diff --git a/pyproject.toml b/pyproject.toml --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ [project] name = "owilix" -version = "4.0.2" +version = "4.0.3" description = "OWILIX - the Command Line Interface for slicing and consuming the Open Web Index. " readme = "Readme.md" license = { text = "MIT" } diff --git a/owilix/_version.py b/owilix/_version.py --- a/owilix/_version.py +++ b/owilix/_version.py @@ -1,3 +1,3 @@ # Version is set here and imported elsewhere -__version__ = "4.0.2" -__version_tuple__ = (4, 0, 2) +__version__ = "4.0.3" +__version_tuple__ = (4, 0, 3) diff --git a/docs/source/install.md b/docs/source/install.md --- a/docs/source/install.md +++ b/docs/source/install.md @@ -11,7 +11,38 @@ ## Quick Install (Recommended) -### Using uv (Fastest) +### One-Line Install + +The easiest way to install owilix. Supports uv, conda, mamba, and pipx. + +```bash +curl -fsSL https://openwebsearcheu-public.pages.it4i.eu/owi-cli/install.sh | bash +``` + +**What the script does:** +- Detects available package managers (uv, conda, mamba, pipx) +- Lets you choose if multiple are available +- Installs uv if none found +- Creates a virtual/conda environment +- Installs owilix and dependencies +- Adds to PATH +- Checks for config migrations + +**Options (via environment variables):** +```bash +# Force specific package manager +OWILIX_PM=uv curl -fsSL ... | bash + +# Upgrade existing installation +OWILIX_UPGRADE=1 curl -fsSL ... | bash + +# Custom install path (for uv/pipx) +OWILIX_PATH=~/my-owilix curl -fsSL ... | bash +``` + +--- + +### Manual Install with uv [uv](https://docs.astral.sh/uv/) is the recommended installer for fastest performance. @@ -21,20 +52,23 @@ # Create a virtual environment and install owilix uv venv --python 3.11 ~/.venv/owilix -source ~/.venv/owilix/bin/activate # On Windows: .venv\owilix\Scripts\activate +source ~/.venv/owilix/bin/activate + +# Install git dependency first (required) +uv pip install "python-http-irods-client @ git+https://opencode.it4i.eu/lexis-platform/data/python-http-irods-client.git@1.1.1" + +# Install owilix uv pip install owilix \ --index-url https://opencode.it4i.eu/api/v4/projects/92/packages/pypi/simple \ --extra-index-url https://opencode.it4i.eu/api/v4/projects/107/packages/pypi/simple -# Add to PATH (optional, for global access) +# Add to PATH (optional) echo 'export PATH="$HOME/.venv/owilix/bin:$PATH"' >> ~/.bashrc source ~/.bashrc # Verify installation owilix --help ``` - -> **Note**: We use `uv venv` instead of `uv tool install` because owilix depends on `python-http-irods-client` which is installed from git. The `uv tool` command doesn't support git dependencies. ### Using pipx (Isolated Environment) -- tangled.sh