Skip to content

Installation

OxideHTTP requires Python 3.13 or newer and is distributed through a private PyPI-compatible package index hosted on Gitea.

Requirements

  • Python 3.13+
  • uv (recommended)

OxideHTTP automatically installs its required dependencies:

  • msgspec
  • pyreqwest

Configure the package index

Add the OxideHTTP package index to your project's pyproject.toml:

[[tool.uv.index]]
name = "OxideHTTP"
url = "https://git.miwory.ru/api/packages/OxideHTTP/pypi/simple"
explicit = true

The explicit = true setting prevents uv from using this index for unrelated dependencies unless explicitly requested.

Install OxideHTTP

Add OxideHTTP to your project:

uv add oxidehttp --index OxideHTTP

Alternatively, add it directly to your dependencies:

[project]
dependencies = [
    "oxidehttp",
]

Then install dependencies:

uv sync

Optional dependencies

Redis support is optional and is not installed by default.

Redis

Install the Redis integration:

uv add "oxidehttp[redis]" --index OxideHTTP

This installs the redis Python package, which is required by the Redis cache implementation.

Verify installation

Check that OxideHTTP can be imported:

uv run python -c "import oxidehttp; print(oxidehttp.__version__)"

You can now create an HTTP client.

Continue to Quickstart.