Skip to content
This repository was archived by the owner on Jun 9, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ It is possible to install `betterproto2_compiler` using pip:
pip install betterproto2_compiler
```

!!! warning
The compiler needs Python 3.10, 3.11 or 3.12. Don't worry! The generated code will be compatible with all Python versions from Python 3.8 to Python 3.13.

## Compile a proto file

Create the following `example.proto` file.
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ help = "Check that the source code is formatted"
cmd = "ruff check src tests"
help = "Check the code with the Ruff linter"

[tool.poe.tasks.serve-docs]
cmd = "mkdocs serve"
help = "Serve the documentation locally"

[tool.poe.tasks.generate_lib]
shell = """
protoc \
Expand Down
Loading