Skip to content

docs: suggest to use uv/uvx/pipx for install/run #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WaYdotNET merged 1 commit into from
Mar 12, 2025
Merged

docs: suggest to use uv/uvx/pipx for install/run #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand Down
Loading