Skip to content
Open
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ easiest using buf, but you can also use protoc if you're feeling
masochistic.

Install the compiler (e.g. `pip install connect-python[compiler]`), and
it can be referenced as `protoc-gen-connect_python`.
it can be referenced as `protoc-gen-connect-python`.

A reasonable `buf.gen.yaml`:
```yaml
Expand All @@ -38,7 +38,7 @@ plugins:
out: .
- remote: buf.build/protocolbuffers/pyi
out: .
- local: .venv/bin/protoc-gen-connect_python
- local: .venv/bin/protoc-gen-connect-python
out: .
```

Expand Down Expand Up @@ -426,7 +426,7 @@ Set up development dependencies:
uv sync --extra dev --extra compiler
```

Install the package in editable mode to produce a local `protoc-gen-connect_python` plugin for use with `protoc`:
Install the package in editable mode to produce a local `protoc-gen-connect-python` plugin for use with `protoc`:
```sh
uv pip install -e .[compiler]
```
Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ With a protobuf definition in hand, you can generate a client. This is
easiest using buf, but you can also use protoc directly.

Install the compiler (eg `pip install connect-python[compiler]`), and
it can be referenced as `protoc-gen-connect_python`.
it can be referenced as `protoc-gen-connect-python`.

### Using Buf (Recommended)

Expand All @@ -34,14 +34,14 @@ plugins:
out: .
- remote: buf.build/protocolbuffers/pyi
out: .
- local: .venv/bin/protoc-gen-connect_python
- local: .venv/bin/protoc-gen-connect-python
out: .
```

### Using protoc

```bash
protoc --plugin=protoc-gen-connect_python=.venv/bin/protoc-gen-connect_python \
protoc --plugin=protoc-gen-connect-python=.venv/bin/protoc-gen-connect-python \
--connect_python_out=. \
--python_out=. \
--pyi_out=. \
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ easiest using buf, but you can also use protoc if you're feeling
masochistic.

Install the compiler (eg `pip install connect-python[compiler]`), and
it can be referenced as `protoc-gen-connect_python`.
it can be referenced as `protoc-gen-connect-python`.

A reasonable `buf.gen.yaml`:
```yaml
Expand All @@ -56,7 +56,7 @@ plugins:
out: .
- remote: buf.build/protocolbuffers/pyi
out: .
- local: .venv/bin/protoc-gen-connect_python
- local: .venv/bin/protoc-gen-connect-python
out: .
```

Expand Down
2 changes: 1 addition & 1 deletion examples/buf.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ plugins:
out: .
- remote: buf.build/protocolbuffers/pyi
out: .
- local: ../.venv/bin/protoc-gen-connect_python
- local: ../.venv/bin/protoc-gen-connect-python
out: .
2 changes: 1 addition & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ integration-test:

# Run protoc with connect_python plugin (development mode). usage: uv run just protoc-gen [PROTOC_ARGS...]
protoc-gen *ARGS:
protoc --plugin=protoc-gen-connect_python=.venv/bin/protoc-gen-connect_python {{ ARGS }}
protoc --plugin=protoc-gen-connect-python=.venv/bin/protoc-gen-connect-python {{ ARGS }}

generate:
cd tests/conformance && buf generate
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ dev = [
]

[project.scripts]
protoc-gen-connect_python = "connectrpc.protoc_gen_connect_python.main:main"
protoc-gen-connect-python = "connectrpc.protoc_gen_connect_python.main:main"

[project.urls]
Homepage = "https://github.com/connectrpc/connect-python"
Expand Down
2 changes: 1 addition & 1 deletion tests/conformance/buf.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ plugins:
out: .
- remote: buf.build/protocolbuffers/pyi
out: .
- local: ../../.venv/bin/protoc-gen-connect_python
- local: ../../.venv/bin/protoc-gen-connect-python
out: .
inputs:
- module: buf.build/connectrpc/conformance:v1.0.4