Merged in feature/PROTO-270-include-the-source-code-folder (pull request #198)

Feature/PROTO-270 include the source code folder

Author: BartHertog

.clinerules/workflows/workflow-embeddedproto.md

@@ -0,0 +1,9 @@
+
+# Building and running unit tests
+To build the unit tests use: `./build_test.sh`
+To run the unit tests use: `./build/test/test_EmbeddedProto`
+
+# Buildin the python package
+Activate the virtual env if not already active: `source ./venv/bin/activate`
+Build the package: `build_package.sh`
+

.github/workflows/distribute_pypi.yml

@@ -18,7 +18,7 @@ jobs:
       run: python3 -m pip install build --user
 
     - name: Build a binary wheel and a source tarball
-      run: python3 -m build
+      run: ./build_package.sh
 
     - name: Store the distribution packages
       uses: actions/upload-artifact@v4

EmbeddedProto/EmbeddedProto.py

@@ -46,6 +46,14 @@ def run_protoc(argv=sys.argv):
     # Remove the program name
     argv.pop(0)
 
+    # Check if the --cpp-src-location parameter is present
+    if "--cpp-src-location" in argv:
+        # Get the location of the src folder
+        src_location = str((resources.files("EmbeddedProto") / "src").resolve())
+        print(src_location)
+        # Exit the script after printing the source location
+        return
+
     # Check if the well known types should be included.
     argv = ["-I" + get_well_known_types_location() if x == "--IncludeWellKnownTypes" else x for x in argv]
 

EmbeddedProto/templates/TypeDefMsg.h.jinja2

@@ -314,7 +314,7 @@ class {{ typedef.get_name() }} final: public ::EmbeddedProto::MessageInterface
       using namespace ::EmbeddedProto;
       return 
         {% for field in typedef.fields %}
-          {{" +" if not loop.first }}{{field.get_type()}}::max_serialized_size(static_cast<uint32_t>(FieldNumber::{{field.variable_id_name}}))
+          {{"+ " if not loop.first }}{{field.get_type()}}::max_serialized_size(static_cast<uint32_t>(FieldNumber::{{field.variable_id_name}}))
         {% endfor %}
         {% for oneof in typedef.oneofs %}
           {{"+ " if not loop.first or typedef.fields|length != 0}}max_serialized_size_{{oneof.get_name()}}()

README.md

@@ -27,6 +27,11 @@ This document details the following:
 
 To stay up to date, signup for our [User Update](https://EmbeddedProto.com/signup).
 
+## 4.0.0
+* TODO Installation via pip3: `pip install EmbeddedProto`. This will also install a matching version of protoc. So you do not need to install the protoc compiler yourself.
+* TODO Run EmbeddedProto as an executable: `embeddedproto -I YOUR_FOLDER YOUR_PROTO_FILE.proto`
+* Included the C++ source files in the python package. You can get the location of these C++ source files by running: `embeddedproto --cpp-src-location`.
+
 ## 3.6.0
 * Update to Protobuf version 32.0.
 * Increated the minimum python version to 3.10.

build_package.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+#
+# Copyright (C) 2020-2025 Embedded AMS B.V. - All Rights Reserved
+#
+# This file is part of Embedded Proto.
+#
+# Embedded Proto is open source software: you can redistribute it and/or 
+# modify it under the terms of the GNU General Public License as published 
+# by the Free Software Foundation, version 3 of the license.
+#
+# Embedded Proto  is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Embedded Proto. If not, see <https://www.gnu.org/licenses/>.
+#
+# For commercial and closed source application please visit:
+# <https://embeddedproto.com/pricing/>.
+#
+# Embedded AMS B.V.
+# Info:
+#   info at EmbeddedProto dot com
+#
+# Postal address:
+#   Atoomweg 2
+#   1627 LE, Hoorn
+#   the Netherlands
+#
+
+# Remove old builds
+rm -rf dist/*
+rm -rf EmbeddedProto.egg-info
+
+# Copy src/ to EmbeddedProto/src/
+cp -r src EmbeddedProto/
+
+# Run the build
+python3 -m build
+
+# Clean up
+rm -rf EmbeddedProto/src

pyproject.toml

@@ -27,7 +27,7 @@ protoc-gen-eams = "EmbeddedProto.main:main_plugin"
 embeddedproto = "EmbeddedProto.EmbeddedProto:run_protoc"
 
 [tool.setuptools.package-data]
-EmbeddedProto = ["templates/*", "version.json"]
+EmbeddedProto = ["templates/*", "version.json", "src/*"]
 
 [build-system]
 requires = ["setuptools>=64", "grpcio-tools==1.75.0"]