From b57ed6221b3bce023ca7abf3bb96405c745da75a Mon Sep 17 00:00:00 2001 From: magi Date: Sun, 6 Sep 2026 21:45:47 +0530 Subject: [PATCH] docs: stop pointing installs at the outdated PyPI package pip install velocix currently pulls 0.1.3, published 2025-11-09 -- before every fix that's landed in this repo since (router 405s, middleware skipping error responses, OpenAPI doc bugs, missing/dead dependency declarations, HTTPClient's hardcoded http2=True, and more). Anyone following the README as written gets a known-broken version with no indication anything's wrong. Pointed installation at git clone + pip install -e . until a new release is actually cut. Publishing to PyPI itself needs the maintainer's own account/credentials, not something I can do from here. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f62cf6..b6835a7 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,15 @@ OpenAPI, security, and testing utilities — built for measurable speed, not cla ## Installation +> **The package on PyPI is outdated.** `pip install velocix` currently installs +> `0.1.3`, published before a long series of bug fixes (routing, middleware, +> OpenAPI docs, dependency declarations, and more). Until a new version is +> released, install from source: + ```bash -pip install velocix +git clone https://github.com/LowLevelLab/velocix.git +cd velocix +pip install -e . ``` Requires Python 3.10 or newer and an ASGI server: