stinger-ipc 0.0.3__tar.gz → 0.0.5__tar.gz

{stinger_ipc-0.0.3/stinger_ipc.egg-info → stinger_ipc-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.3
+Version: 0.0.5
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
@@ -11,6 +11,7 @@ Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: ruamel-yaml>=0.18.14
 Requires-Dist: stringcase>=1.2.0
+Requires-Dist: typer>=0.16.1
 Requires-Dist: yamlloader>=1.5.1
 Dynamic: license-file
 

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stinger-ipc"
-version = "0.0.3"
+version = "0.0.5"
 description = "Tools to create code to do IPC over MQTT"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -11,6 +11,7 @@ dependencies = [
     "pyyaml>=6.0.2",
     "ruamel-yaml>=0.18.14",
     "stringcase>=1.2.0",
+    "typer>=0.16.1",
     "yamlloader>=1.5.1",
 ]
 
@@ -41,6 +42,6 @@ stingeripc = [
 ]
 
 [project.scripts]
-pythongen = "stingeripc.tools.python_generator:main"
+pythongen = "stingeripc.tools.python_generator:run"
 rustgen = "stingeripc.tools.rust_generator:main"
-markdowngen = "stingeripc.tools.markdown_generator:main"
+markdowngen = "stingeripc.tools.markdown_generator:run"

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5/stinger_ipc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.3
+Version: 0.0.5
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
@@ -11,6 +11,7 @@ Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: ruamel-yaml>=0.18.14
 Requires-Dist: stringcase>=1.2.0
+Requires-Dist: typer>=0.16.1
 Requires-Dist: yamlloader>=1.5.1
 Dynamic: license-file
 

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stinger_ipc.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ stingeripc/templates/cpp/include/broker.hpp.jinja2
 stingeripc/templates/cpp/include/client.hpp.jinja2
 stingeripc/templates/cpp/include/enums.hpp.jinja2
 stingeripc/templates/cpp/include/ibrokerconnection.hpp.jinja2
+stingeripc/templates/cpp/include/property_structs.hpp.jinja2
 stingeripc/templates/cpp/include/return_types.hpp.jinja2
 stingeripc/templates/cpp/include/server.hpp.jinja2
 stingeripc/templates/cpp/include/structs.hpp.jinja2

stinger_ipc-0.0.5/stinger_ipc.egg-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+markdowngen = stingeripc.tools.markdown_generator:run
+pythongen = stingeripc.tools.python_generator:run
+rustgen = stingeripc.tools.rust_generator:main

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stinger_ipc.egg-info/requires.txt

@@ -4,4 +4,5 @@ pydantic>=2.11.7
 pyyaml>=6.0.2
 ruamel-yaml>=0.18.14
 stringcase>=1.2.0
+typer>=0.16.1
 yamlloader>=1.5.1

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/components.py

@@ -3,7 +3,7 @@ from enum import Enum
 import random
 import stringcase
 from abc import abstractmethod
-from typing import Dict, List, Optional, Any, Union
+from typing import Any
 from .topic import (
     SignalTopicCreator,
     InterfaceTopicCreator,
@@ -387,7 +387,7 @@ class Signal(InterfaceComponent):
     def __init__(self, topic_creator: SignalTopicCreator, name: str):
         super().__init__(name)
         self._topic_creator = topic_creator
-        self._arg_list = []  # type: List[Arg]
+        self._arg_list: list[Arg] = []
 
     def add_arg(self, arg: Arg) -> Signal:
         if arg.name in [a.name for a in self._arg_list]:
@@ -408,7 +408,7 @@ class Signal(InterfaceComponent):
         cls,
         topic_creator: SignalTopicCreator,
         name: str,
-        signal_spec: Dict[str, str],
+        signal_spec: dict[str, str],
         stinger_spec: StingerSpec | None = None,
     ) -> "Signal":
         """Alternative constructor from a Stinger signal structure."""
@@ -437,7 +437,7 @@ class Method(InterfaceComponent):
         super().__init__(name)
         self._python = PythonMethodSymbols(self)
         self._topic_creator = topic_creator
-        self._arg_list = []  # type: List[Arg]
+        self._arg_list: list[Arg] = []
         self._return_value: Arg | list[Arg] | None = None
 
     @property
@@ -482,7 +482,7 @@ class Method(InterfaceComponent):
     @property
     def return_value_cpp_class(self) -> str:
         if self._return_value is None:
-            return "null"
+            return "void"
         elif isinstance(self._return_value, Arg):
             return self._return_value.cpp_type
         elif isinstance(self._return_value, list):
@@ -572,7 +572,7 @@ class Method(InterfaceComponent):
         cls,
         topic_creator: MethodTopicCreator,
         name: str,
-        method_spec: Dict[str, str],
+        method_spec: dict[str, str],
         stinger_spec: StingerSpec | None = None,
     ) -> "Method":
         """Alternative constructor from a Stinger method structure."""
@@ -614,7 +614,7 @@ class Property(InterfaceComponent):
     def __init__(self, topic_creator: PropertyTopicCreator, name: str):
         super().__init__(name)
         self._topic_creator = topic_creator
-        self._arg_list = []  # type: List[Arg]
+        self._arg_list: list[Arg] = []
         self._read_only = False
 
     def add_arg(self, arg: Arg) -> Property:
@@ -829,7 +829,7 @@ class InterfaceStruct:
     def new_struct_from_stinger(
         cls,
         name,
-        spec: Dict[str, str | List[Dict[str, str]]],
+        spec: dict[str, str | list[dict[str, str]]],
         stinger_spec: StingerSpec,
     ) -> InterfaceStruct:
         istruct = cls(name)
@@ -884,7 +884,7 @@ class Broker:
         self._port = port
 
     @classmethod
-    def new_broker_from_stinger(cls, name: str, spec: Dict[str, Any]) -> Broker:
+    def new_broker_from_stinger(cls, name: str, spec: dict[str, Any]) -> Broker:
         new_broker = cls(name=name)
         if "host" in spec:
             new_broker.hostname = spec["host"]
@@ -897,13 +897,14 @@ class Broker:
 
 
 class StingerSpec:
-    def __init__(self, topic_creator: InterfaceTopicCreator, interface):
+    def __init__(self, topic_creator: InterfaceTopicCreator, interface: dict[str, Any]):
         self._topic_creator = topic_creator
         try:
             self._name: str = interface["name"]
             self._version: str = interface["version"]
             self._python = PythonInterfaceSymbols(self)
             self._rust = RustInterfaceSymbols(self)
+            self._cpp = CppInterfaceSymbols(self)
         except KeyError as e:
             raise InvalidStingerStructure(
                 f"Missing interface property in {interface}: {e}"
@@ -913,8 +914,9 @@ class StingerSpec:
                 f"Interface didn't appear to have a correct type"
             )
 
-        self._summary = interface["summary"] if "summary" in interface else None
-        self._title = interface["title"] if "title" in interface else None
+        self._summary = interface.get("summary")
+        self._title = interface.get("title")
+        self._documentation = interface.get("documentation")
 
         self.signals: dict[str, Signal] = {}
         self.properties: dict[str, Property] = {}
@@ -951,7 +953,7 @@ class StingerSpec:
         self._brokers[broker.name] = broker
 
     @property
-    def brokers(self) -> Dict[str, Broker]:
+    def brokers(self) -> dict[str, Broker]:
         if len(self._brokers) == 0:
             default_broker = Broker()
             return {default_broker.name: default_broker}
@@ -1007,6 +1009,10 @@ class StingerSpec:
     def rust(self) -> RustInterfaceSymbols:
         return self._rust
 
+    @property
+    def cpp(self) -> CppInterfaceSymbols:
+        return self._cpp
+
     @staticmethod
     def get_enum_module_name() -> str:
         return InterfaceEnum.get_module_name()
@@ -1017,7 +1023,7 @@ class StingerSpec:
 
     @classmethod
     def new_spec_from_stinger(
-        cls, topic_creator, stinger: Dict[str, Any]
+        cls, topic_creator, stinger: dict[str, Any]
     ) -> StingerSpec:
         if "stingeripc" not in stinger:
             raise InvalidStingerStructure("Missing 'stingeripc' format version")

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/lang_symb.py

@@ -5,6 +5,10 @@ class PythonSymbols:
     def __init__(self):
         ...
 
+    @property
+    def package_name(self):
+        return f"{stringmanip.lower_camel_case(self._iface.name).lower()}ipc"
+
     @property
     def type_definition_module(self) -> str:
         return "stinger_types"
@@ -51,7 +55,11 @@ class PythonMethodSymbols(PythonSymbols):
     def return_value_class(self):
         return f"{self.type_definition_module}.{self.return_value_local_class}"
 
-class RustInterfaceSymbols(PythonSymbols):
+class RustSymbols:
+    def __init__(self):
+        pass
+
+class RustInterfaceSymbols(RustSymbols):
 
     def __init__(self, interface):
         super().__init__()
@@ -66,3 +74,29 @@ class RustInterfaceSymbols(PythonSymbols):
     def server_struct_name(self) -> str:
         """ Name of the struct for the interface server."""
         return f"{stringmanip.upper_camel_case(self._iface.name)}Server"
+
+class CppSymbols:
+    def __init__(self):
+        pass
+
+class CppInterfaceSymbols(CppSymbols):
+    
+    def __init__(self, interface):
+        super().__init__()
+        self._iface = interface
+
+    @property
+    def client_class_name(self) -> str:
+        return f"{stringmanip.upper_camel_case(self._iface.name)}Client"
+    
+    @property
+    def server_class_name(self) -> str:
+        return f"{stringmanip.upper_camel_case(self._iface.name)}Server"
+
+    @property
+    def enum_header_file(self) -> str:
+        return "enums.hpp"
+    
+    @property
+    def property_struct_header_file(self) -> str:
+        return "property_structs.hpp"

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/examples/client_main.cpp.jinja2

@@ -7,8 +7,8 @@
 int main(int argc, char** argv) {
 
     {%set broker = stinger.get_example_broker()%}
-    auto conn = std::make_shared<{{broker.class_name}}>({%if broker.hostname is none%}"localhost", 1883, {%endif%}"{{stinger.name | UpperCamelCase}}Client-demo");
-    {{stinger.name | UpperCamelCase}}Client client(conn);
+    auto conn = std::make_shared<{{broker.class_name}}>({%if broker.hostname is none%}"localhost", 1883, {%endif%}"{{stinger.cpp.client_class_name}}-demo");
+    {{stinger.cpp.client_class_name}} client(conn);
 
     {%-for sig_name, sig in stinger.signals.items() %}
     client.register{{sig_name | UpperCamelCase}}Callback([]({%for arg in sig.arg_list%}{{arg.cpp_type}} {{arg.name}}{%if not loop.last%}, {%endif%}{%endfor%}) {

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/examples/server_main.cpp.jinja2

@@ -3,13 +3,13 @@
 
 #include "broker.hpp"
 #include "server.hpp"
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 
 int main(int argc, char** argv) {
 
     {%set broker = stinger.get_example_broker()%}
-    auto conn = std::make_shared<{{broker.class_name}}>({%if broker.hostname is none%}"localhost", 1883, {%endif%}"{{stinger.name | UpperCamelCase}}Serve-demo");
-    {{stinger.name | UpperCamelCase}}Server server(conn);
+    auto conn = std::make_shared<{{broker.class_name}}>({%if broker.hostname is none%}"localhost", 1883, {%endif%}"{{stinger.name | UpperCamelCase}}");
+    {{stinger.cpp.server_class_name}} server(conn);
 
     {%-for sig_name, sig in stinger.signals.items() %}
     auto {{sig_name}}Future = server.emit{{sig_name | UpperCamelCase}}Signal({%for arg in sig.arg_list%}{{arg.get_random_example_value(lang="c++")}}{%if not loop.last%}, {%endif%}{%endfor%});
@@ -22,9 +22,9 @@ int main(int argc, char** argv) {
     server.register{{method_name | UpperCamelCase}}Handler([]({%for arg in method.arg_list%}{{arg.cpp_type}} unused{{loop.index}}{%if not loop.last%}, {%endif%}{%endfor%}) -> {{method.return_value_cpp_class}}
     {
         std::cout << "Received call for {{method_name}}\n";
-        {%if method.return_value_type == 'struct'%}
+        {%-if method.return_value_type == 'struct'%}
         return {{method.return_value_name | UpperCamelCase}}{ {{method.get_return_value_random_example_value('c++')}} };
-        {%else%}
+        {%-elif method.return_value_type is not false %}
         return {{method.get_return_value_random_example_value('c++')}};
         {%-endif%}
     });

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/broker.hpp.jinja2

@@ -1,3 +1,10 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
 
 #pragma once
 

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/client.hpp.jinja2

@@ -1,3 +1,10 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
 
 #pragma once
 
@@ -11,10 +18,11 @@
 #include <boost/uuid/uuid.hpp>
 
 #include "ibrokerconnection.hpp"
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 #include "return_types.hpp"
+{%if stinger.properties | length > 0 %}#include "{{stinger.cpp.property_struct_header_file}}"{%endif%}
 
-class {{stinger.name | UpperCamelCase}}Client {
+class {{stinger.cpp.client_class_name}} {
 
 public:
     // This is the name of the API.
@@ -23,9 +31,9 @@ public:
     static constexpr const char INTERFACE_VERSION[] = "{{stinger.version}}";
 
     // Constructor taking a connection object.
-    {{stinger.name | UpperCamelCase}}Client(std::shared_ptr<IBrokerConnection> broker);
+    {{stinger.cpp.client_class_name}}(std::shared_ptr<IBrokerConnection> broker);
 
-    virtual ~{{stinger.name | UpperCamelCase}}Client() = default;
+    virtual ~{{stinger.cpp.client_class_name}}() = default;
 
     {%for sig_name, sig in stinger.signals.items()%}
     // Register a callback for the `{{sig_name}}` signal.

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/ibrokerconnection.hpp.jinja2

@@ -1,3 +1,10 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
 
 #pragma once
 

stinger_ipc-0.0.5/stingeripc/templates/cpp/include/property_structs.hpp.jinja2

@@ -0,0 +1,10 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
+{%for prop_name, prop in stinger.properties.items() %}
+// {{prop}}
+{%endfor%}

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/return_types.hpp.jinja2

@@ -1,7 +1,14 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
 
 #pragma once
 #include <string>
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 
 {%for method_name, method in stinger.methods.items()%}
 {%-if method.return_value_type == 'struct'%}

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/server.hpp.jinja2

@@ -1,3 +1,10 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
+
 
 #pragma once
 
@@ -12,18 +19,18 @@
 #include <rapidjson/document.h>
 
 #include "ibrokerconnection.hpp"
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 #include "return_types.hpp"
 
-class {{stinger.name | UpperCamelCase}}Server {
+class {{stinger.cpp.server_class_name}} {
 
 public:
     static constexpr const char NAME[] = "{{stinger.name}}";
     static constexpr const char INTERFACE_VERSION[] = "{{stinger.version}}";
 
-    {{stinger.name | UpperCamelCase}}Server(std::shared_ptr<IBrokerConnection> broker);
+    {{stinger.cpp.server_class_name}}(std::shared_ptr<IBrokerConnection> broker);
 
-    virtual ~{{stinger.name | UpperCamelCase}}Server() = default;
+    virtual ~{{stinger.cpp.server_class_name}}() = default;
 
     {%for sig_name, sig in stinger.signals.items()%}
     boost::future<bool> emit{{sig_name | UpperCamelCase}}Signal({%for arg in sig.arg_list%}{{arg.cpp_type}}{%if not loop.last%}, {%endif%}{%endfor%});

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/include/structs.hpp.jinja2

@@ -1,8 +1,14 @@
+/*
+DO NOT MODIFY THIS FILE.  It is automatically generated and changes will be over-written
+on the next generation.
+
+It contains enumerations used by the {{stinger.name}} interface.
+*/
 
 #pragma once
 #include <string>
 #include <boost/optional.hpp>
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 
 {%for istruct_name, istruct in stinger.structs.items() %}
 struct {{istruct_name | UpperCamelCase }} {

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/src/client.cpp.jinja2

@@ -13,14 +13,14 @@
 #include <rapidjson/document.h>
 
 #include "client.hpp"
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 #include "ibrokerconnection.hpp"
 
 
-constexpr const char {{stinger.name | UpperCamelCase}}Client::NAME[];
-constexpr const char {{stinger.name | UpperCamelCase}}Client::INTERFACE_VERSION[];
+constexpr const char {{stinger.cpp.client_class_name}}::NAME[];
+constexpr const char {{stinger.cpp.client_class_name}}::INTERFACE_VERSION[];
 
-{{stinger.name | UpperCamelCase}}Client::{{stinger.name | UpperCamelCase}}Client(std::shared_ptr<IBrokerConnection> broker) : _broker(broker)
+{{stinger.cpp.client_class_name}}::{{stinger.cpp.client_class_name}}(std::shared_ptr<IBrokerConnection> broker) : _broker(broker)
 {
     _broker->AddMessageCallback([this](const std::string& topic, const std::string& payload, const boost::optional<std::string> optCorrelationId, const boost::optional<std::string> unusedRespTopic, const boost::optional<MethodResultCode> optResultCode)
     {
@@ -39,7 +39,7 @@ constexpr const char {{stinger.name | UpperCamelCase}}Client::INTERFACE_VERSION[
     {%-endfor%}
 }
 
-void {{stinger.name | UpperCamelCase}}Client::_receiveMessage(
+void {{stinger.cpp.client_class_name}}::_receiveMessage(
         const std::string& topic, 
         const std::string& payload, 
         const boost::optional<std::string> optCorrelationId, 
@@ -106,14 +106,14 @@ void {{stinger.name | UpperCamelCase}}Client::_receiveMessage(
 
 
 {%-for sig_name, sig in stinger.signals.items() %}
-void {{stinger.name | UpperCamelCase}}Client::register{{sig_name | UpperCamelCase}}Callback(const std::function<void({%for arg in sig.arg_list%}{{arg.cpp_type}}{%if not loop.last%}, {%endif%}{%endfor%})>& cb)
+void {{stinger.cpp.client_class_name}}::register{{sig_name | UpperCamelCase}}Callback(const std::function<void({%for arg in sig.arg_list%}{{arg.cpp_type}}{%if not loop.last%}, {%endif%}{%endfor%})>& cb)
 {
     _{{sig_name | camelCase}}Callback = cb;
 }
 {%-endfor%}
 
 {%for method_name, method in stinger.methods.items()%}
-boost::future<{{method.return_value_cpp_class}}> {{stinger.name | UpperCamelCase}}Client::{{method_name | camelCase}}({%for arg in method.arg_list%}{{arg.cpp_type}} {{arg.name}}{%if not loop.last%}, {%endif%}{%endfor%})
+boost::future<{{method.return_value_cpp_class}}> {{stinger.cpp.client_class_name}}::{{method_name | camelCase}}({%for arg in method.arg_list%}{{arg.cpp_type}} {{arg.name}}{%if not loop.last%}, {%endif%}{%endfor%})
 {
     auto correlationId = boost::uuids::random_generator()();
     const std::string correlationIdStr = boost::lexical_cast<std::string>(correlationId);
@@ -122,7 +122,7 @@ boost::future<{{method.return_value_cpp_class}}> {{stinger.name | UpperCamelCase
     rapidjson::Document doc;
     doc.SetObject();
 
-    {%macro addToDoc(arg)%}
+    {%-macro addToDoc(arg)%}
     {%-if arg.arg_type.name.lower() == 'primitive'%}
     {%-if arg.optional %}if ({{arg.name}}) {%endif-%}
     {%-if arg.type.name.lower() == 'string'%}
@@ -151,7 +151,7 @@ boost::future<{{method.return_value_cpp_class}}> {{stinger.name | UpperCamelCase
     return _pending{{method_name|UpperCamelCase}}MethodCalls[correlationId].get_future();
 }
 
-void {{stinger.name | UpperCamelCase}}Client::_handle{{method_name|UpperCamelCase}}Response(
+void {{stinger.cpp.client_class_name}}::_handle{{method_name|UpperCamelCase}}Response(
         const std::string& topic, 
         const std::string& payload, 
         const std::string &correlationId) 
@@ -182,6 +182,7 @@ void {{stinger.name | UpperCamelCase}}Client::_handle{{method_name|UpperCamelCas
         {%endif-%}
         {%endmacro-%}
         {%if method.return_value_type == 'struct'-%}
+        // Response has multiple values.
         {%for item in method.return_value%}
         {{unpack_rv(item)}}
         {%-endfor%}
@@ -191,8 +192,12 @@ void {{stinger.name | UpperCamelCase}}Client::_handle{{method_name|UpperCamelCas
         {%-endfor%}
         };
         promiseItr->second.set_value(returnValue);
+        {%-elif method.return_value_type is false %}
+        // There are no values in the response.
+        promiseItr->second.set_value();
         {%-else%}
-        {{-unpack_rv(method.return_value)}}
+        // Response has a single value.
+        {{unpack_rv(method.return_value)}}
         promiseItr->second.set_value({{method.return_value_property_name}});
         {%-endif%}
     }

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/cpp/src/server.cpp.jinja2

@@ -11,14 +11,14 @@
 #include <rapidjson/document.h>
 
 #include "server.hpp"
-#include "enums.hpp"
+#include "{{stinger.cpp.enum_header_file}}"
 #include "ibrokerconnection.hpp"
 
 
-constexpr const char {{stinger.name | UpperCamelCase}}Server::NAME[];
-constexpr const char {{stinger.name | UpperCamelCase}}Server::INTERFACE_VERSION[];
+constexpr const char {{stinger.cpp.server_class_name}}::NAME[];
+constexpr const char {{stinger.cpp.server_class_name}}::INTERFACE_VERSION[];
 
-{{stinger.name | UpperCamelCase}}Server::{{stinger.name | UpperCamelCase}}Server(std::shared_ptr<IBrokerConnection> broker) : _broker(broker) {
+{{stinger.cpp.server_class_name}}::{{stinger.cpp.server_class_name}}(std::shared_ptr<IBrokerConnection> broker) : _broker(broker) {
     _broker->AddMessageCallback([this](const std::string& topic, const std::string& payload, const boost::optional<std::string> optCorrelationId, const boost::optional<std::string> optResponseTopic, const boost::optional<MethodResultCode> unusedRc)
     {
         _receiveMessage(topic, payload, optCorrelationId, optResponseTopic);
@@ -28,7 +28,7 @@ constexpr const char {{stinger.name | UpperCamelCase}}Server::INTERFACE_VERSION[
     {%endfor%}
 }
 
-void {{stinger.name | UpperCamelCase}}Server::_receiveMessage(
+void {{stinger.cpp.server_class_name}}::_receiveMessage(
         const std::string& topic, 
         const std::string& payload, 
         const boost::optional<std::string> optCorrelationId, 
@@ -67,7 +67,7 @@ void {{stinger.name | UpperCamelCase}}Server::_receiveMessage(
 }
 
 {%for sig_name, sig in stinger.signals.items()%}
-boost::future<bool> {{stinger.name | UpperCamelCase}}Server::emit{{sig_name | UpperCamelCase}}Signal({%for arg in sig.arg_list%}{{arg.cpp_type}} {{arg.name}}{%if not loop.last%}, {%endif%}{%endfor%})
+boost::future<bool> {{stinger.cpp.server_class_name}}::emit{{sig_name | UpperCamelCase}}Signal({%for arg in sig.arg_list%}{{arg.cpp_type}} {{arg.name}}{%if not loop.last%}, {%endif%}{%endfor%})
 {
     rapidjson::Document doc;
     doc.SetObject();
@@ -98,7 +98,7 @@ boost::future<bool> {{stinger.name | UpperCamelCase}}Server::emit{{sig_name | Up
 {%endfor%}
 
 {%for method_name, method in stinger.methods.items()%}
-void {{stinger.name | UpperCamelCase}}Server::register{{method_name | UpperCamelCase}}Handler(std::function<{{method.return_value_cpp_class}}({%for arg in method.arg_list%}{{arg.cpp_type}}{%if not loop.last%}, {%endif%}{%endfor%})> func)
+void {{stinger.cpp.server_class_name}}::register{{method_name | UpperCamelCase}}Handler(std::function<{{method.return_value_cpp_class}}({%for arg in method.arg_list%}{{arg.cpp_type}}{%if not loop.last%}, {%endif%}{%endfor%})> func)
 {
     std::cout << "Registered method to handle {{method.topic}}\n";
     _{{method_name | camelCase}}Handler = func;
@@ -106,7 +106,7 @@ void {{stinger.name | UpperCamelCase}}Server::register{{method_name | UpperCamel
 {%endfor%}
 
 {%for method_name, method in stinger.methods.items()%}
-void {{stinger.name | UpperCamelCase}}Server::_call{{method_name | UpperCamelCase}}Handler(
+void {{stinger.cpp.server_class_name}}::_call{{method_name | UpperCamelCase}}Handler(
         const std::string& topic, 
         const rapidjson::Document& doc, 
         const boost::optional<std::string> optCorrelationId,
@@ -130,12 +130,13 @@ void {{stinger.name | UpperCamelCase}}Server::_call{{method_name | UpperCamelCas
         }
         {%endfor%}
 
-        {{method.return_value_cpp_class}} ret = _{{method_name | camelCase}}Handler({%for arg in method.arg_list%}temp{{arg.name|UpperCamelCase}}{%if not loop.last%}, {%endif%}{%endfor%});
+        {%if method.return_value_type is not false%}{{method.return_value_cpp_class}} ret = {%endif%}_{{method_name | camelCase}}Handler({%for arg in method.arg_list%}temp{{arg.name|UpperCamelCase}}{%if not loop.last%}, {%endif%}{%endfor%});
 
         if (optResponseTopic)
         {
             rapidjson::Document responseJson;
             responseJson.SetObject();
+            
             {%macro add_arg_to_json(arg, value) %}
             // add the {{arg.name}} (a/n {{arg.arg_type.name}}) to the json
             rapidjson::Value returnValue{{arg.name|UpperCamelCase}};
@@ -150,16 +151,15 @@ void {{stinger.name | UpperCamelCase}}Server::_call{{method_name | UpperCamelCas
             {%-endif%} {# value or enum#}
             responseJson.AddMember("{{arg.name}}", returnValue{{arg.name|UpperCamelCase}}, responseJson.GetAllocator());
             {%endmacro%}
-
             {%-if method.return_value_type == 'struct'%}
             // Return type is a struct of values that need added to json
             {%for member in method.return_value-%}
             {{add_arg_to_json(member, "ret."+member.name)}}
             {%endfor%}
-            {%-else%}
+            {%-elif method.return_value_type is not false%}
+            // Return type is a single value
             {{add_arg_to_json(method.return_value, "ret")}}
             {%-endif%}
-
             rapidjson::StringBuffer buf;
             rapidjson::Writer<rapidjson::StringBuffer> writer(buf);
             responseJson.Accept(writer);

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/templates/markdown/index.md.jinja2

@@ -1,6 +1,79 @@
 # _{{stinger.name}}_ API Overview 
+{%-if stinger.summary %} 
+_{{stinger.summary}}_
+{%endif-%}
+{%if stinger.documentation%}
+{{stinger.documentation}}
+
+## Connections
+
+A connection object is a wrapper around an MQTT client and provides specific functionality to support both clients and servers.
+Generally, you only need one connection object per daemon/program, as it can support multiple clients and servers.  
+
+### Connection code Examples
+
+<details>
+  <summary>Python</summary>
+
+```python{%set broker = stinger.get_example_broker()%}
+from connection import {{broker.class_name}}
+
+connection_object = {{broker.class_name}}({%if broker.hostname is none%}'localhost', 1883{%endif%})
+```
+
+The `connection_object` will be passed to client and server constructors.
+
+</details>
+
+<details>
+  <summary>C++</summary>
+
+```c++{%set broker = stinger.get_example_broker()%}
+#include "broker.hpp"
+
+auto connection_object = std::make_shared<{{broker.class_name}}>({%if broker.hostname is none%}"localhost", 1883, {%endif%}"{{stinger.name | UpperCamelCase}}");
+```
+
+The `connection_object` will be passed to client and server constructors.
+
+</details>
+
+## Server
 
-{{stinger.description}}
+A server is a _provider_ of functionality.  It sends signals, handles method calls, and owns property values.
+
+### Server Code Examples
+
+<details>
+  <summary>Python Server</summary>
+
+```python{%set broker = stinger.get_example_broker()%}
+from {{stinger.python.package_name}}.client import {{stinger.cpp.server_class_name}}
+
+server = {{stinger.python.server_class_name}}(connection_object)
+```
+
+The `server` object provides methods for emitting signals and updating properties.  It also allows for decorators to indicate method call handlers.
+
+</details>
+
+<details>
+  <summary>C++ Server</summary>
+
+```python{%set broker = stinger.get_example_broker()%}
+from connection import {{broker.class_name}}
+
+conn = {{broker.class_name}}({%if broker.hostname is none%}'localhost', 1883{%endif%})
+server = {{stinger.python.server_class_name}}(conn)
+```
+
+The `server` object provides methods for emitting signals and updating properties.  It also allows for decorators to indicate method call handlers.
+
+</details>
+
+## Client
+
+{%endif-%}
 {%macro argrow(arg) -%}
 |{{arg.name|center(15)}}|
 {%-if arg.arg_type.name.lower() == "enum" or arg.arg_type.name.lower() == "struct"%}{{arg.markdown_type|center(10)}}

{stinger_ipc-0.0.3 → stinger_ipc-0.0.5}/stingeripc/tools/markdown_generator.py

@@ -1,12 +1,15 @@
 import os
 import sys
 from jacobsjinjatoo import templator as jj2
-
+import os.path
+import typer
+from typing_extensions import Annotated
 from stingeripc import StingerInterface
+from rich import print
+from pathlib import Path
 
-def main():
-    inname = sys.argv[1]
-    outdir = sys.argv[2]
+def main(inname: Annotated[Path, typer.Argument(exists=True, file_okay=True, dir_okay=False, readable=True)], outdir: Annotated[Path, typer.Argument(file_okay=False, dir_okay=True, writable=True, readable=True)]):
+    print(f"[bold green]Reading:[/bold green] {inname}")
     with open(inname, "r") as f:
         stinger = StingerInterface.from_yaml(f)
     params = {
@@ -19,7 +22,11 @@ def main():
     for output_file in [
         "index.md",
     ]:
+        print(f"[bold red]GENERATING:[/bold red] {output_file}")
         t.render_template(f"{output_file}.jinja2", output_file, **params)
 
-if __name__ == '__main__':
-    main()
+def run():
+    typer.run(main)
+
+if __name__ == "__main__":
+    run()

stinger_ipc-0.0.5/stingeripc/tools/python_generator.py

@@ -0,0 +1,49 @@
+from jacobsjinjatoo import templator as jj2
+from jacobsjinjatoo import stringmanip
+import sys
+import os.path
+import typer
+from typing_extensions import Annotated
+from stingeripc import StingerInterface
+from rich import print
+from pathlib import Path
+
+def main(inname: Annotated[Path, typer.Argument(exists=True, file_okay=True, dir_okay=False, readable=True)], outdir: Annotated[Path, typer.Argument(file_okay=False, dir_okay=True, writable=True, readable=True)]):
+
+    print(f"[bold green]Reading:[/bold green] {inname}")
+    with open(inname, "r") as f:
+        stinger = StingerInterface.from_yaml(f)
+    params = {
+        "stinger": stinger,
+    }
+    t = jj2.CodeTemplator(output_dir=os.path.dirname(outdir))
+    t.add_template_dir(
+        os.path.join(os.path.dirname(__file__), "../templates", "python")
+    )
+    for output_file in [
+        "pyproject.toml",
+    ]:
+        print(f"[bold red]Generating:[/bold red] {output_file}")
+        t.render_template(f"{output_file}.jinja2", os.path.join(outdir, output_file), **params)
+
+    package_name = f"{stringmanip.lower_camel_case(stinger.name).lower()}ipc"
+    generated_pkg_dir = os.path.join(outdir, package_name)
+    print(f"[bold red]Making Directory:[/bold red] {generated_pkg_dir}")
+    os.makedirs(generated_pkg_dir, exist_ok=True)
+    for output_file in [
+        "server.py",
+        "client.py",
+        "connection.py",
+        "__init__.py",
+        "method_codes.py",
+    ]:
+        print(f"[bold red]Generating:[/bold red] {output_file}")
+        t.render_template(f"{output_file}.jinja2", os.path.join(generated_pkg_dir, output_file), **params)
+
+    t.render_template("interface_types.py.jinja2", os.path.join(generated_pkg_dir, f"{stinger.get_enum_module_name()}.py"), **params)
+
+def run():
+    typer.run(main)
+
+if __name__ == "__main__":
+    run()

stinger_ipc-0.0.3/stinger_ipc.egg-info/entry_points.txt

@@ -1,4 +0,0 @@
-[console_scripts]
-markdowngen = stingeripc.tools.markdown_generator:main
-pythongen = stingeripc.tools.python_generator:main
-rustgen = stingeripc.tools.rust_generator:main

stinger_ipc-0.0.3/stingeripc/tools/python_generator.py

@@ -1,41 +0,0 @@
-from jacobsjinjatoo import templator as jj2
-import sys
-import yaml
-import os.path
-
-
-
-from stingeripc import StingerInterface
-
-def main():
-    inname = sys.argv[1]
-    outdir = sys.argv[2]
-    with open(inname, "r") as f:
-        stinger = StingerInterface.from_yaml(f)
-    params = {
-        "stinger": stinger,
-    }
-    t = jj2.CodeTemplator(output_dir=os.path.dirname(outdir))
-    t.add_template_dir(
-        os.path.join(os.path.dirname(__file__), "../templates", "python")
-    )
-    for output_file in [
-        "pyproject.toml",
-    ]:
-        t.render_template(f"{output_file}.jinja2", output_file, **params)
-
-    generated_src_dir = os.path.join(outdir, stinger.name.lower())
-    os.makedirs(generated_src_dir, exist_ok=True)
-    for output_file in [
-        "server.py",
-        "client.py",
-        "connection.py",
-        "__init__.py",
-        "method_codes.py",
-    ]:
-        t.render_template(f"{output_file}.jinja2", os.path.join(stinger.name.lower(), output_file), **params)
-
-    t.render_template("interface_types.py.jinja2", os.path.join(stinger.name.lower(), f"{stinger.get_enum_module_name()}.py"), **params)
-
-if __name__ == "__main__":
-    main()