neuroglia-python 0.1.1__tar.gz → 0.1.3__tar.gz

neuroglia_python-0.1.3/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.3
+Name: neuroglia-python
+Version: 0.1.3
+Summary: Port from .NET to Python of the Neuroglia Framework
+License: Apache
+Author: Charles d'Avernas
+Author-email: charles.davernas@neuroglia.io
+Requires-Python: >=3.12,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: annotated-types (>0.6.0)
+Requires-Dist: classy-fastapi (>=0.6.1,<0.7.0)
+Requires-Dist: esdbclient (>1)
+Requires-Dist: fastapi (>=0.115.12,<0.116.0)
+Requires-Dist: grpcio (>=1.71)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
+Requires-Dist: mkdocs-material (>=9.5.46,<10.0.0)
+Requires-Dist: multipledispatch (>=1.0.0,<2.0.0)
+Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
+Requires-Dist: pymongo (>=4.6.1,<5.0.0)
+Requires-Dist: pytest (>=8.1.1,<9.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: rx (>=3.2.0,<4.0.0)
+Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
+Requires-Dist: uvicorn (>=0.34.0,<0.35.0)
+Description-Content-Type: text/markdown
+
+# Neuroglia Python Framework
+
+The framework is a very thin software layer built on top of [FastAPI](https://fastapi.tiangolo.com/) that provides developers with a set of coding features and tools that may be useful for any microservice (regardless of its role and domain/bounded context), such as:
+
+- Implements all guidelines from https://12factor.net
+- MVC Web App builder with fundamental abstractions
+- Simple Dependency Injection mechanism, including automatic class discovery and instantiation
+- Class-based API controller with automatic module discovery
+- Modular Command/Query responsibility segregation
+- Optional Event-sourcing for event-driven Domain modeling
+- Clean layered Code https://levelup.gitconnected.com/clean-architecture-86c4f03e4771
+  - Pure Domain models, independent of persistence
+  - Application handlers (Command, Queries, Events, Tasks)
+  - Repository pattern
+  - Independent API controllers, endpoints and models (DTO's) vs Domain models and logic
+- Native async Events ingestion, handling, emission (JSON [CloudEvent](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md)) using [ReactiveX programming](https://medium.com/@willAmaral/asynchronous-programming-and-rx-anything-479d9cb8daee) with [RxPy](https://rxpy.readthedocs.io/en/latest/)
+- Data models mapping between Domain and Integration
+- Easy extension for background task scheduling with [apscheduler](https://apscheduler.readthedocs.io/en/3.x/)
+- etc...
+
+The code typically includes comments that help understand it.
+
+The `src/main.py` file is the entry point that defines all dependencies, including the sub-folders where to dynamically load the API, Application, Persistence and Domain layers.
+
+In turn, when booting, the web app dynamically discovers, identifies and instantiate dependencies then loads:
+
+- API controllers and define the mapping between each endpoint and its corresponding Application handler
+- Application handlers (incl. Commands, Queries, Events, Tasks) and services (any business logic)
+- Integration dependencies (any API client service, persistence-layer clients, ) and models (API' DTO for requests and responses)
+
+## Documentation
+
+Temporarily hosted at https://bvandewe.github.io/pyneuro/
+
+## Disclaimer
+
+This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
+
+## Packaging
+
+```sh
+# Set the version tag in pyproject.toml
+# Commit changes
+
+poetry build
+
+poetry publish --repository gitlab -u <token-username> -p <token-password>
+
+```
+

neuroglia_python-0.1.3/README.md

@@ -0,0 +1,49 @@
+# Neuroglia Python Framework
+
+The framework is a very thin software layer built on top of [FastAPI](https://fastapi.tiangolo.com/) that provides developers with a set of coding features and tools that may be useful for any microservice (regardless of its role and domain/bounded context), such as:
+
+- Implements all guidelines from https://12factor.net
+- MVC Web App builder with fundamental abstractions
+- Simple Dependency Injection mechanism, including automatic class discovery and instantiation
+- Class-based API controller with automatic module discovery
+- Modular Command/Query responsibility segregation
+- Optional Event-sourcing for event-driven Domain modeling
+- Clean layered Code https://levelup.gitconnected.com/clean-architecture-86c4f03e4771
+  - Pure Domain models, independent of persistence
+  - Application handlers (Command, Queries, Events, Tasks)
+  - Repository pattern
+  - Independent API controllers, endpoints and models (DTO's) vs Domain models and logic
+- Native async Events ingestion, handling, emission (JSON [CloudEvent](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md)) using [ReactiveX programming](https://medium.com/@willAmaral/asynchronous-programming-and-rx-anything-479d9cb8daee) with [RxPy](https://rxpy.readthedocs.io/en/latest/)
+- Data models mapping between Domain and Integration
+- Easy extension for background task scheduling with [apscheduler](https://apscheduler.readthedocs.io/en/3.x/)
+- etc...
+
+The code typically includes comments that help understand it.
+
+The `src/main.py` file is the entry point that defines all dependencies, including the sub-folders where to dynamically load the API, Application, Persistence and Domain layers.
+
+In turn, when booting, the web app dynamically discovers, identifies and instantiate dependencies then loads:
+
+- API controllers and define the mapping between each endpoint and its corresponding Application handler
+- Application handlers (incl. Commands, Queries, Events, Tasks) and services (any business logic)
+- Integration dependencies (any API client service, persistence-layer clients, ) and models (API' DTO for requests and responses)
+
+## Documentation
+
+Temporarily hosted at https://bvandewe.github.io/pyneuro/
+
+## Disclaimer
+
+This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
+
+## Packaging
+
+```sh
+# Set the version tag in pyproject.toml
+# Commit changes
+
+poetry build
+
+poetry publish --repository gitlab -u <token-username> -p <token-password>
+
+```

{neuroglia_python-0.1.1 → neuroglia_python-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "neuroglia-python"
-version = "0.1.1"
+version = "0.1.3"
 description = "Port from .NET to Python of the Neuroglia Framework"
 authors = ["Charles d'Avernas <charles.davernas@neuroglia.io>"]
 license = "Apache"
@@ -8,21 +8,22 @@ readme = "README.md"
 packages = [
     { include = "neuroglia", from = "src" },
 ]
+package-mode = true
 
 [tool.poetry.dependencies]
 python = "^3.12"
-annotated-types = "^0.6.0"
+annotated-types = ">0.6.0"
 classy-fastapi = "^0.6.1"
-esdbclient = "^1.0.17"
-fastapi = "^0.109.2"
-grpcio = "^1.60.1"
-httpx = "^0.26.0"
+esdbclient = ">1"
+fastapi = "^0.115.12"
+grpcio = ">=1.71"
+httpx = "^0.28.1"
 multipledispatch = "^1.0.0"
 pydantic-settings = "^2.2.0"
 pymongo = "^4.6.1"
 python-dotenv = "^1.0.1"
 rx = "^3.2.0"
-uvicorn = "^0.27.1"
+uvicorn = "^0.34.0"
 typing-extensions = "^4.9.0"
 pytest = "^8.1.1"
 mkdocs = "^1.6.1"
@@ -30,7 +31,7 @@ mkdocs-material = "^9.5.46"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.0.1"
-pytest-asyncio = "^0.23.5"
+pytest-asyncio = "^0.26.0"
 mypy = "^1.8.0"
 autopep8 = "^2.0.4"
 coverage = "^7.4.1"

{neuroglia_python-0.1.1 → neuroglia_python-0.1.3}/src/neuroglia/eventing/cloud_events/cloud_event.py

@@ -1,6 +1,6 @@
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 
 class CloudEventSpecVersion:
@@ -26,7 +26,7 @@ class CloudEvent:
         dataschema (Optional[str]): An URI that references the versioned schema of the event's data.
         data (Optional[Any]): The event's data, if any. Only used if the event has been formatted using the structured mode.
         data_base64 (Optional[str]): The event's binary data, encoded in base 64. Used if the event has been formatted using the binary mode.
-        **extensions: Keyword arguments representing extension attributes.
+        extensionAttributes (Optional[Dict[str, Any]]): A mapping containing the event's extension attributes.
     '''
 
     id: str
@@ -65,31 +65,8 @@ class CloudEvent:
     data_base64: Optional[str] = None
     ''' Gets/sets the event's binary data, encoded in base 64. Used if the event has been formatted using the binary mode. '''
 
-    extensions: Dict[str, Any] = field(default_factory=dict)  # Store extensions in a dict
-    ''' Gets/sets a mapping containing the event's extension attributes. '''
-
-    def __post_init__(self, *args, **kwargs):
-        # Capture any additional keyword arguments as extension attributes
-        for key, value in kwargs.items():
-            # only add them if they are not already defined fields
-            if key not in self.__dataclass_fields__:
-                self.extensions[key] = value
-
-    def __getattr__(self, name):
-        # Allow access to extensions as attributes
-        if name in self.extensions:
-            return self.extensions[name]
-        raise AttributeError(f"'{self.__class__.__name__}' object has no attribute '{name}'")
-
-    def __setattr__(self, name, value):
-        # Allow setting of extensions as attributes if it is an extension or not a predefined field.
-        if name in self.extensions or name not in self.__dataclass_fields__:
-            self.extensions[name] = value
-        else:
-            super().__setattr__(name, value)  # Use default setting for standard attributes
-
     def get_attribute(self, name: str) -> Optional[Any]:
         ''' Gets the value of the attribute with the specified name, if any '''
         if not name:
             raise ValueError("Attribute name cannot be empty or None.")
-        return getattr(self, name, None)  # Use getattr to check both standard and extension attributes
+        self.__dict__[name] if name in self.__dict__.keys() else None

neuroglia_python-0.1.3/src/neuroglia/logging/logger.py

@@ -0,0 +1,82 @@
+import logging
+import os
+import typing
+
+# def configure_simplest_logging():
+#     logging.basicConfig(filename='logs/openbank.log', format='%(asctime)s %(levelname)-8s %(message)s', encoding='utf-8', level=logging.DEBUG)
+#     console_handler = logging.StreamHandler(sys.stdout)
+#     console_handler.setLevel(logging.DEBUG)
+#     log = logging.getLogger(__name__)
+#     log.addHandler(console_handler)
+
+
+# def configure_logging_from_config(config_path: str):
+#     # config_path = "logging.conf"
+#     logging.config.fileConfig(config_path, disable_existing_loggers=True)
+
+
+DEFAULT_LOG_FORMAT = "%(asctime)s %(levelname) - 8s %(name)s:%(lineno)d %(message)s"
+DEFAULT_LOG_FILENAME = "logs/debug.log"
+DEFAULT_LOG_LEVEL = "DEBUG"
+DEFAULT_LOG_LIBRARIES_LIST = ["asyncio", "httpx", "httpcore"]
+DEFAULT_LOG_LIBRARIES_LEVEL = "WARN"
+
+
+def configure_logging(
+    log_level: str = DEFAULT_LOG_LEVEL,
+    log_format: str = DEFAULT_LOG_FORMAT,
+    console: bool = True,
+    file: bool = True,
+    filename: str = DEFAULT_LOG_FILENAME,
+    lib_list: typing.List = DEFAULT_LOG_LIBRARIES_LIST,
+    lib_level: str = DEFAULT_LOG_LIBRARIES_LEVEL,
+):
+    """Configures the root logger with the given format and handler(s).
+       Optionally, the log level for some libraries may be customized separately
+       (which is interesting when setting a log level DEBUG on root but not wishing to see debugs for all libs).
+
+    Args:
+        log_level (str, optional): The log_level for the root logger. Defaults to DEFAULT_LOG_LEVEL.
+        log_format (str, optional): The format of the log records. Defaults to DEFAULT_LOG_FORMAT.
+        console (bool, optional): Whether to enable the console handler. Defaults to True.
+        file (bool, optional): Whether to enable the file-based handler. Defaults to True.
+        filename (str, optional): If file-based handler is enabled, this will set the filename of the log file. Defaults to DEFAULT_LOG_FILENAME.
+        lib_list (typing.List, optional): List of libraries/packages name. Defaults to DEFAULT_LOG_LIBRARIES_LIST.
+        lib_level (str, optional): The separate log level for the libraries included in the lib_list. Defaults to DEFAULT_LOG_LIBRARIES_LEVEL.
+    """
+    root_logger = logging.getLogger()
+    root_logger.setLevel(log_level)
+    formatter = logging.Formatter(log_format)
+    if console:
+        _configure_console_based_logging(root_logger, log_level, formatter)
+    if file:
+        _configure_file_based_logging(root_logger, log_level, formatter, filename)
+
+    for lib_name in lib_list:
+        logging.getLogger(lib_name).setLevel(lib_level)
+
+
+def _configure_console_based_logging(root_logger, log_level, formatter):
+    console_handler = logging.StreamHandler()
+    handler = _configure_handler(console_handler, log_level, formatter)
+    root_logger.addHandler(handler)
+
+
+def _configure_file_based_logging(root_logger, log_level, formatter, filename):
+    # Ensure the directory exists
+    os.makedirs(os.path.dirname(filename), exist_ok=True)
+
+    # Check if the file exists, if not, create it
+    if not os.path.isfile(filename):
+        with open(filename, "w"):  # This will create the file if it does not exist
+            pass
+
+    file_handler = logging.FileHandler(filename)
+    handler = _configure_handler(file_handler, log_level, formatter)
+    root_logger.addHandler(handler)
+
+
+def _configure_handler(handler: logging.StreamHandler, log_level, formatter) -> logging.StreamHandler:
+    handler.setLevel(log_level)
+    handler.setFormatter(formatter)
+    return handler

neuroglia_python-0.1.1/PKG-INFO

@@ -1,49 +0,0 @@
-Metadata-Version: 2.1
-Name: neuroglia-python
-Version: 0.1.1
-Summary: Port from .NET to Python of the Neuroglia Framework
-License: Apache
-Author: Charles d'Avernas
-Author-email: charles.davernas@neuroglia.io
-Requires-Python: >=3.12,<4.0
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: annotated-types (>=0.6.0,<0.7.0)
-Requires-Dist: classy-fastapi (>=0.6.1,<0.7.0)
-Requires-Dist: esdbclient (>=1.0.17,<2.0.0)
-Requires-Dist: fastapi (>=0.109.2,<0.110.0)
-Requires-Dist: grpcio (>=1.60.1,<2.0.0)
-Requires-Dist: httpx (>=0.26.0,<0.27.0)
-Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
-Requires-Dist: mkdocs-material (>=9.5.46,<10.0.0)
-Requires-Dist: multipledispatch (>=1.0.0,<2.0.0)
-Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
-Requires-Dist: pymongo (>=4.6.1,<5.0.0)
-Requires-Dist: pytest (>=8.1.1,<9.0.0)
-Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
-Requires-Dist: rx (>=3.2.0,<4.0.0)
-Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Requires-Dist: uvicorn (>=0.27.1,<0.28.0)
-Description-Content-Type: text/markdown
-
-# Neuroglia Python Framework
-
-A framework of libraries used to build modern Python V3 applications
-
-## Disclaimer
-
-This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
-
-## Packaging
-
-```sh
-# Set the version tag in pyproject.toml
-# Commit changes
-
-poetry build
-
-poetry publish --repository gitlab -u <token-username> -p <token-password>
-
-```
-

neuroglia_python-0.1.1/README.md

@@ -1,19 +0,0 @@
-# Neuroglia Python Framework
-
-A framework of libraries used to build modern Python V3 applications
-
-## Disclaimer
-
-This project was the opportunity for me (cdavernas) to learn Python while porting some of the concepts and services of the .NET version of the Neuroglia Framework
-
-## Packaging
-
-```sh
-# Set the version tag in pyproject.toml
-# Commit changes
-
-poetry build
-
-poetry publish --repository gitlab -u <token-username> -p <token-password>
-
-```