Merge pull request #20 from bringauto/python_protobuf_as_module

Python protobuf files restructured to work as a module

Author: MarioIvancik

.gitignore

@@ -1,3 +1,4 @@
 _*
+!__init__.py
 cmake-build-*
 .idea

CMakeLists.txt

@@ -1,7 +1,7 @@
 CMAKE_MINIMUM_REQUIRED(VERSION 3.25 FATAL_ERROR)
 PROJECT(fleet-protocol C CXX)
 
-SET(FLEET_PROTOCOL_VERSION 2.0.0)
+SET(FLEET_PROTOCOL_VERSION 2.0.3)
 SET(FLEET_PROTOCOL_NAMESPACE "fleet-protocol-interface::")
 
 OPTION(BRINGAUTO_PACKAGE "Package creation" OFF)

README.md

@@ -78,6 +78,11 @@ If a message field is not mandatory, then it's marked as OPTIONAL by "OPTIONAL"
 as the last comment in documentation for the given field.
 Optional fields have defaults as described in the [ProtoBuf] v3 doc.
 
+### Python protobuf files
+
+To use the compiled python protobuf files in a project, install the module in `protobuf/compiled/python`.
+For example: add this project as a submodule and add `file:fleet-protocol/protobuf/compiled/python` to `requirements.txt`. Then it can be imported as `fleet_protocol_protobuf_files`.
+
 ## Repo structure
 
 This repository contains a basic C API and CMake project to easily

protobuf/README.md

@@ -18,10 +18,10 @@ TARGET_LINK_LIBRARIES(<target> PUBLIC protobuf::libprotobuf protobuf-cpp-interfa
 
 ## Compilation
 
-Compile to all languages:
+Compile to all languages: (compiling python requires an extra step!)
 
 ```
-find protobuf/definition -name "*.proto" -exec protoc -I=protobuf/definition --cpp_out=compiled/cpp --csharp_out=compiled/cs --python_out=compiled/python --go_out=compiled/go/ --go_opt=paths=source_relative {} +
+find definition -name "*.proto" -exec protoc -I=./definition --cpp_out=./compiled/cpp --csharp_out=./compiled/cs --python_out=./compiled/python/fleet_protocol_protobuf_files --go_out=./compiled/go/ --go_opt=paths=source_relative {} +
 ```
 
 To compile files to a specific language only, use the specific `*_out` options in command.
@@ -30,19 +30,33 @@ Note that protoc doesn't support double asterisks (**), so it should be used wit
 **C++**
 
 ```
-find protobuf/definition -name "*.proto" -exec protoc -I=./definition --cpp_out=./compiled/cpp {} +
+find definition -name "*.proto" -exec protoc -I=./definition --cpp_out=./compiled/cpp {} +
 ```
 
 **C#**
 
 ```
-find protobuf/definition -name "*.proto" -exec protoc -I=./definition --csharp_out=./compiled/cpp {} +
+find definition -name "*.proto" -exec protoc -I=./definition --csharp_out=./compiled/cs {} +
 ```
 
 **Python**
 
 ```
-find protobuf/definition -name "*.proto" -exec protoc -I=./definition --python_out=./compiled/cpp {} +
+find definition -name "*.proto" -exec protoc -I=./definition --python_out=./compiled/python/fleet_protocol_protobuf_files {} +
+```
+
+Afterwards, edit all local imports to start with `fleet_protocol_protobuf_files.`
+
+e.g.:
+
+from
+```python
+import InternalProtocol_pb2 as InternalProtocol__pb2
+```
+
+to
+```python
+import fleet_protocol_protobuf_files.InternalProtocol_pb2 as InternalProtocol__pb2
 ```
 
 **GO**

protobuf/compiled/python/.gitignore

@@ -0,0 +1,2 @@
+build
+*.egg-info

…/compiled/python/ExternalProtocol_pb2.py …l_protobuf_files/ExternalProtocol_pb2.pyprotobuf/compiled/python/ExternalProtocol_pb2.py renamed to protobuf/compiled/python/fleet_protocol_protobuf_files/ExternalProtocol_pb2.py protobuf/compiled/python/ExternalProtocol_pb2.py renamed to protobuf/compiled/python/fleet_protocol_protobuf_files/ExternalProtocol_pb2.py

@@ -0,0 +1,7 @@
+[project]
+name = "fleet_protocol_protobuf_files"
+version = "2.0.3"
+
+
+[tool.setuptools.packages.find]
+include = ["fleet_protocol_protobuf_files"]