Skip to content

Commit d2c2ac6

Browse files
Update README
1 parent 088df22 commit d2c2ac6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,8 @@ To build and install pydgraph locally, run
596596
pip install -e ".[dev]"
597597
```
598598

599+
#### Regenerating protobufs
600+
599601
If you have made changes to the `pydgraph/proto/api.proto` file, you need need to regenerate the
600602
source files generated by Protocol Buffer tools. To do that, install the
601603
[grpcio-tools][grpcio-tools] library and then run the following command:
@@ -612,9 +614,13 @@ users with older grpcio versions, providing a graceful upgrade path. It also use
612614
eliminates Python 3.12+ deprecation warnings. The dev dependencies in `pyproject.toml` are pinned to
613615
the correct version (grpcio-tools 1.65.x)
614616

617+
If you are using python version 3.13 or higher, an error will be raised if you try to run
618+
`scripts/protogen.py`. This is to prevent generating protobufs that are incompatible with older
619+
grpcio-tools versions.
620+
615621
#### grpcio 1.65.0 is the minimum version
616622

617-
While we would prefer to support older grpcio versions, practical limitations prevent this:
623+
Older grpcio versions have practical limitations:
618624

619625
- **Compilation failures**: grpcio versions older than ~1.60.0 fail to compile from source on modern
620626
systems (macOS with recent Xcode, newer Linux distributions) due to C++ compiler compatibility

0 commit comments

Comments
 (0)