From a364852d707215f0afd7c2c1515ab282a8d946e8 Mon Sep 17 00:00:00 2001 From: Raffaele Salmaso Date: Wed, 12 Mar 2025 21:04:38 +0100 Subject: [PATCH] docs: suggest to use uv/uvx/pipx for install/run --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6511905..2306779 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,19 @@ A bidirectional Python code generator that converts between AsyncAPI 3.0 specifi ## Installation 📦 +**with [uv](https://docs.astral.sh/uv/)**: ```bash -pip install zen-generator +uv tool install zen-generator +``` + +**with [pipx](https://pipx.pypa.io/stable/)**: +```bash +pipx install zen-generator +``` + +**with [uvx](https://docs.astral.sh/uv/guides/tools/)**: +```bash +uvx zen-generator ``` > [!IMPORTANT] @@ -47,13 +58,13 @@ Convert between AsyncAPI 3.0 specifications and Python code: ```bash # Generate FastAPI implementation from AsyncAPI spec -zen-generator fastapi +uvx zen-generator fastapi -# Generate pure Python implementation from AsyncAPI spec -zen-generator pure-python +# Generate pure Python implementation from AsyncAPI spec +uvx zen-generator pure-python # Generate AsyncAPI spec from Python code -zen-generator asyncapi-documentation +uvx zen-generator asyncapi-documentation ``` ### Command Line Interface