Skip to content

Document uv support in README #1489

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

Open
johnthagen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document uv support in README #1489

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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ _Be forewarned, this is a beta-level feature in the sense that the API exposed i

## What You Get

1. A `pyproject.toml` file, optionally with [Poetry] metadata (default), [PDM] (with `--meta=pdm`), or only [Ruff] config.
1. A `pyproject.toml` file, optionally with [Poetry] metadata (default), [uv] (with `--meta=uv`), [PDM]
(with `--meta=pdm`), or only [Ruff] config.
2. A `README.md` you'll most definitely need to update with your project's details
3. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
1. A `client` module which will have both a `Client` class and an `AuthenticatedClient` class. You'll need these
Expand Down Expand Up @@ -200,7 +201,7 @@ This extension has been adopted by similar projects such as [OpenAPI Tools](http
It is intended to provide user-friendly names for integer Enum members that get generated.
It is critical that the length of the array matches that of the enum values.

```
```json
"Colors": {
"type": "integer",
"format": "int32",
Expand All @@ -218,7 +219,7 @@ It is critical that the length of the array matches that of the enum values.
```

Results in:
```
```json
class Color(IntEnum):
RED = 0
GREEN = 1
Expand All @@ -227,5 +228,6 @@ class Color(IntEnum):

[changelog.md]: CHANGELOG.md
[poetry]: https://python-poetry.org/
[uv]: https://docs.astral.sh/uv/
[PDM]: https://pdm-project.org/latest/
[Ruff]: https://docs.astral.sh/ruff/
Loading