neuroglia-python 0.0.23__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. neuroglia/__init__.py +0 -0
  2. neuroglia/core/__init__.py +4 -0
  3. neuroglia/core/module_loader.py +13 -0
  4. neuroglia/core/operation_result.py +11 -0
  5. neuroglia/core/problem_details.py +25 -0
  6. neuroglia/core/type_extensions.py +75 -0
  7. neuroglia/core/type_finder.py +24 -0
  8. neuroglia/data/__init__.py +1 -0
  9. neuroglia/data/abstractions.py +124 -0
  10. neuroglia/data/infrastructure/__init__.py +0 -0
  11. neuroglia/data/infrastructure/abstractions.py +78 -0
  12. neuroglia/data/infrastructure/event_sourcing/__init__.py +0 -0
  13. neuroglia/data/infrastructure/event_sourcing/abstractions.py +126 -0
  14. neuroglia/data/infrastructure/event_sourcing/event_sourcing_repository.py +77 -0
  15. neuroglia/data/infrastructure/event_sourcing/event_store/__init__.py +0 -0
  16. neuroglia/data/infrastructure/event_sourcing/event_store/event_store.py +175 -0
  17. neuroglia/data/infrastructure/event_sourcing/read_model_reconciliator.py +62 -0
  18. neuroglia/data/infrastructure/memory/__init__.py +1 -0
  19. neuroglia/data/infrastructure/memory/memory_repository.py +29 -0
  20. neuroglia/data/infrastructure/mongo/__init__.py +0 -0
  21. neuroglia/data/infrastructure/mongo/mongo_repository.py +331 -0
  22. neuroglia/data/queries/generic/__init__.py +2 -0
  23. neuroglia/data/queries/generic/get_by_id_query.py +30 -0
  24. neuroglia/data/queries/generic/list_query.py +23 -0
  25. neuroglia/data/queryable.py +175 -0
  26. neuroglia/dependency_injection/__init__.py +1 -0
  27. neuroglia/dependency_injection/service_provider.py +341 -0
  28. neuroglia/eventing/cloud_events/__init__.py +1 -0
  29. neuroglia/eventing/cloud_events/cloud_event.py +72 -0
  30. neuroglia/eventing/cloud_events/decorators.py +5 -0
  31. neuroglia/eventing/cloud_events/infrastructure/__init__.py +4 -0
  32. neuroglia/eventing/cloud_events/infrastructure/cloud_event_bus.py +11 -0
  33. neuroglia/eventing/cloud_events/infrastructure/cloud_event_ingestor.py +74 -0
  34. neuroglia/eventing/cloud_events/infrastructure/cloud_event_middleware.py +39 -0
  35. neuroglia/eventing/cloud_events/infrastructure/cloud_event_publisher.py +103 -0
  36. neuroglia/expressions/__init__.py +0 -0
  37. neuroglia/expressions/javascript_expression_translator.py +147 -0
  38. neuroglia/hosting/__init__.py +0 -0
  39. neuroglia/hosting/abstractions.py +141 -0
  40. neuroglia/hosting/configuration/data_access_layer.py +50 -0
  41. neuroglia/hosting/web.py +87 -0
  42. neuroglia/integration/__init__.py +0 -0
  43. neuroglia/integration/models.py +18 -0
  44. neuroglia/mapping/__init__.py +1 -0
  45. neuroglia/mapping/mapper.py +238 -0
  46. neuroglia/mediation/__init__.py +1 -0
  47. neuroglia/mediation/mediator.py +182 -0
  48. neuroglia/mvc/__init__.py +0 -0
  49. neuroglia/mvc/controller_base.py +72 -0
  50. neuroglia/reactive/__init__.py +1 -0
  51. neuroglia/reactive/rx_async.py +16 -0
  52. neuroglia/serialization/__init__.py +0 -0
  53. neuroglia/serialization/abstractions.py +30 -0
  54. neuroglia/serialization/json.py +212 -0
  55. neuroglia_python-0.0.23.dist-info/LICENSE +201 -0
  56. neuroglia_python-0.0.23.dist-info/METADATA +127 -0
  57. neuroglia_python-0.0.23.dist-info/RECORD +58 -0
  58. neuroglia_python-0.0.23.dist-info/WHEEL +4 -0
@@ -0,0 +1,212 @@
1
+ import json
2
+ from datetime import datetime
3
+ from enum import Enum
4
+ import typing
5
+ from neuroglia.hosting.abstractions import ApplicationBuilderBase
6
+ from neuroglia.serialization.abstractions import Serializer, TextSerializer
7
+ from typing import Any, Dict, Optional, Type, Union, get_args, get_origin
8
+ from dataclasses import is_dataclass, fields
9
+
10
+
11
+ class JsonEncoder(json.JSONEncoder):
12
+
13
+ def default(self, obj):
14
+ if issubclass(type(obj), Enum):
15
+ return obj.name
16
+ elif issubclass(type(obj), datetime):
17
+ return obj.isoformat()
18
+ elif hasattr(obj, "__dict__"):
19
+ filtered_dict = {
20
+ key: value
21
+ for key, value in obj.__dict__.items()
22
+ if not key.startswith("_") and value is not None
23
+ }
24
+ return filtered_dict
25
+ try:
26
+ return super().default(obj)
27
+ except Exception:
28
+ return str(obj)
29
+
30
+
31
+ class JsonSerializer(TextSerializer):
32
+ """Represents the service used to serialize/deserialize to/from JSON"""
33
+
34
+ def serialize(self, value: Any) -> bytearray:
35
+ text = self.serialize_to_text(value)
36
+ if text is None:
37
+ return None
38
+ return text.encode()
39
+
40
+ def serialize_to_text(self, value: Any) -> str:
41
+ return json.dumps(value, cls=JsonEncoder)
42
+
43
+ def deserialize(self, input: bytearray, expected_type: Any | None) -> Any:
44
+ return self.deserialize_from_text(input.decode(), expected_type)
45
+
46
+ def deserialize_from_text(
47
+ self, input: str, expected_type: Optional[Type] = None
48
+ ) -> Any:
49
+ value = json.loads(input)
50
+ if expected_type is None or not isinstance(value, dict):
51
+ return value
52
+ elif expected_type == dict:
53
+ return dict(value)
54
+ fields = {}
55
+ for base_type in reversed(expected_type.__mro__):
56
+ if not hasattr(base_type, "__annotations__"):
57
+ continue
58
+ for key, field_type in base_type.__annotations__.items():
59
+ if key in value:
60
+ fields[key] = self._deserialize_nested(value[key], field_type)
61
+ value = object.__new__(expected_type)
62
+ value.__dict__ = fields
63
+ return value
64
+
65
+ def _deserialize_nested(self, value: Any, expected_type: Type) -> Any:
66
+ """Recursively deserializes a nested object. Support native types (str, int, float, bool) as well as Generic Types that also include subtypes (typing.Dict, typing.List)."""
67
+
68
+ # Handle None for Optional types
69
+ if value is None:
70
+ return None
71
+
72
+ origin_type = get_origin(expected_type)
73
+ if origin_type is not None:
74
+ # This is a generic type (e.g., Optional[SomeType], List[SomeType])
75
+ type_args = get_args(expected_type)
76
+ if origin_type is Union and type(None) in type_args:
77
+ # This is an Optional type
78
+ non_optional_type = next(t for t in type_args if t is not type(None))
79
+ return self._deserialize_nested(value, non_optional_type)
80
+
81
+ elif origin_type in (list, typing.List):
82
+ # Handle List deserialization
83
+ if len(type_args) > 0:
84
+ # List with type hints (e.g. typing.List[str])
85
+ item_type = type_args[0]
86
+ else:
87
+ item_type = type(value[0]) if value else object
88
+
89
+ # Deserialize each item in the list
90
+ return [self._deserialize_nested(v, item_type) for v in value]
91
+
92
+ elif origin_type is dict:
93
+ # Handle Dict deserialization
94
+ if len(type_args) > 0:
95
+ # Dictionary with type hints (e.g. typing.Dict[str, int])
96
+ key_type, val_type = type_args
97
+ return {
98
+ self._deserialize_nested(k, key_type): self._deserialize_nested(
99
+ v, val_type
100
+ )
101
+ for k, v in value.items()
102
+ }
103
+ else:
104
+ # Dictionary without type hints, use the actual type of each value
105
+ return {
106
+ k: self._deserialize_nested(v, type(v))
107
+ for k, v in value.items()
108
+ }
109
+
110
+ if isinstance(value, dict):
111
+ # Handle Dataclass deserialization
112
+ if is_dataclass(expected_type):
113
+ field_dict = {}
114
+ for field in fields(expected_type):
115
+ if field.name in value:
116
+ field_value = self._deserialize_nested(
117
+ value[field.name], field.type
118
+ )
119
+ field_dict[field.name] = field_value
120
+ value = object.__new__(expected_type)
121
+ value.__dict__ = field_dict
122
+ return value
123
+
124
+ # If the expected type is a plain dict, we need to deserialize each value in the dict.
125
+ if hasattr(expected_type, "__args__") and expected_type.__args__:
126
+ # Dictionary with type hints (e.g. typing.Dict[str, int])
127
+ key_type, val_type = expected_type.__args__
128
+ return {
129
+ self._deserialize_nested(k, key_type): self._deserialize_nested(
130
+ v, val_type
131
+ )
132
+ for k, v in value.items()
133
+ }
134
+ else:
135
+ # Dictionary without type hints, use the actual type of each value
136
+ return {
137
+ k: self._deserialize_nested(v, type(v)) for k, v in value.items()
138
+ }
139
+
140
+ elif isinstance(value, list):
141
+ # List with type hints (e.g. typing.List[str])
142
+ if hasattr(expected_type, "__args__") and expected_type.__args__:
143
+ # Extract the actual type from the generic alias
144
+ item_type = expected_type.__args__[0]
145
+ if hasattr(item_type, "__origin__"): # Check if it's a generic alias
146
+ if len(item_type.__args__) == 1:
147
+ item_type = item_type.__args__[0] # Get the actual type
148
+ else:
149
+ item_type = item_type.__origin__
150
+
151
+ else:
152
+ item_type = type(value[0]) if value else object
153
+
154
+ # Deserialize each item in the list
155
+ items = [self._deserialize_nested(v, item_type) for v in value]
156
+ values = []
157
+
158
+ for item in items:
159
+ if isinstance(item, (int, str, float, bool)):
160
+ # For simple types, the deserialized item is already in the correct form
161
+ values.append(item)
162
+ elif isinstance(item_type, type):
163
+ # For complex types or custom classes, instantiate using __new__
164
+ new_item = object.__new__(item_type)
165
+ if hasattr(new_item, "__dict__"):
166
+ # If the new item has a __dict__, we can directly update it
167
+ new_item.__dict__.update(item)
168
+ elif isinstance(item, dict):
169
+ new_item = item
170
+ values.append(new_item)
171
+ else:
172
+ # If item_type is not a class type, just use the item as is
173
+ values.append(item)
174
+ return values
175
+
176
+ elif isinstance(value, str) and expected_type == datetime:
177
+ return datetime.fromisoformat(value)
178
+
179
+ elif (
180
+ hasattr(expected_type, "__bases__")
181
+ and expected_type.__bases__
182
+ and issubclass(expected_type, Enum)
183
+ ):
184
+ # Handle Enum deserialization
185
+ for enum_member in expected_type:
186
+ if enum_member.value == value:
187
+ return enum_member
188
+ raise ValueError(
189
+ f"Invalid enum value for {
190
+ expected_type.__name__}: {value}"
191
+ )
192
+
193
+ else:
194
+ # Return the value as is for types that do not require deserialization
195
+ return value
196
+
197
+ def configure(builder: ApplicationBuilderBase) -> ApplicationBuilderBase:
198
+ """Configures the specified application builder to use the JsonSerializer"""
199
+ builder.services.add_singleton(JsonSerializer)
200
+ builder.services.add_singleton(
201
+ Serializer,
202
+ implementation_factory=lambda provider: provider.get_required_service(
203
+ JsonSerializer
204
+ ),
205
+ )
206
+ builder.services.add_singleton(
207
+ TextSerializer,
208
+ implementation_factory=lambda provider: provider.get_required_service(
209
+ JsonSerializer
210
+ ),
211
+ )
212
+ return builder
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,127 @@
1
+ Metadata-Version: 2.1
2
+ Name: neuroglia-python
3
+ Version: 0.0.23
4
+ Summary: Port from .NET to Python of the Neuroglia Framework
5
+ License: Apache
6
+ Author: Charles d'Avernas
7
+ Author-email: charles.davernas@neuroglia.io
8
+ Requires-Python: >=3.12,<4.0
9
+ Classifier: License :: Other/Proprietary License
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: Programming Language :: Python :: 3.13
13
+ Requires-Dist: annotated-types (>=0.6.0,<0.7.0)
14
+ Requires-Dist: classy-fastapi (>=0.6.1,<0.7.0)
15
+ Requires-Dist: esdbclient (>=1.0.17,<2.0.0)
16
+ Requires-Dist: fastapi (>=0.109.2,<0.110.0)
17
+ Requires-Dist: grpcio (>=1.60.1,<2.0.0)
18
+ Requires-Dist: httpx (>=0.26.0,<0.27.0)
19
+ Requires-Dist: multipledispatch (>=1.0.0,<2.0.0)
20
+ Requires-Dist: pydantic-settings (>=2.2.0,<3.0.0)
21
+ Requires-Dist: pymongo (>=4.6.1,<5.0.0)
22
+ Requires-Dist: pytest (>=8.1.1,<9.0.0)
23
+ Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
24
+ Requires-Dist: rx (>=3.2.0,<4.0.0)
25
+ Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
26
+ Requires-Dist: uvicorn (>=0.27.1,<0.28.0)
27
+ Description-Content-Type: text/markdown
28
+
29
+ # Neuroglia Python Framework
30
+
31
+ A framework of libraries used to build modern Python V3 applications
32
+
33
+ ## Disclaimer
34
+
35
+ 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
36
+
37
+ ## Packaging
38
+
39
+ ```sh
40
+ # Set the version tag in pyproject.toml
41
+ # Commit changes
42
+
43
+ poetry build
44
+
45
+ poetry publish --repository gitlab -u <token-username> -p <token-password>
46
+
47
+ ```
48
+
49
+ ---
50
+
51
+ _DRAFT_
52
+
53
+ ## Developer Guide Structure
54
+
55
+ ### Introduction
56
+
57
+ Briefly describe your framework, its purpose, and its target audience.
58
+ Highlight key features and benefits.
59
+
60
+ #### Installation:
61
+
62
+ Provide clear and step-by-step instructions on how to install your framework, including:
63
+ Prerequisites (e.g., Python version, dependencies)
64
+ Installation methods (e.g., pip install <framework_name>, source code compilation)
65
+ Virtual environment recommendations (for isolation and dependency management)
66
+
67
+ #### Getting Started:
68
+
69
+ Offer a simple "Hello, World!" or similar example to demonstrate basic usage and familiarize users with your framework's syntax and structure.
70
+ Include code snippets and explanations where necessary.
71
+
72
+ #### Core Concepts:
73
+
74
+ Dedicate this section to in-depth explanations of the fundamental building blocks and functionalities of your framework. This might include:
75
+ Key objects and classes within the framework
76
+ Data structures and design patterns employed
77
+ Architectural overview (e.g., MVC, MVVM) if applicable
78
+
79
+ #### Tutorials and Examples:
80
+
81
+ Provide a collection of well-structured, step-by-step tutorials that showcase how to accomplish common tasks using your framework.
82
+ Consider varying the difficulty levels (beginner, intermediate, advanced) to cater to a wide range of users.
83
+ Include code examples, explanations, and screenshots as needed.
84
+
85
+ #### API Reference:
86
+
87
+ Create a comprehensive reference for all available classes, functions, and modules within your framework.
88
+ Use a consistent format that includes the following information for each API element:
89
+ Name
90
+ Description
91
+ Arguments (with data types and descriptions)
92
+ Return values (with data types and descriptions)
93
+ Usage examples
94
+
95
+ #### Testing and Debugging:
96
+
97
+ Explain how to effectively test code written using your framework.
98
+ Recommend testing frameworks and tools.
99
+ Provide practical guidance on common debugging techniques and strategies.
100
+
101
+ #### Contributing:
102
+
103
+ Outline how developers can contribute to your framework's development.
104
+ Include information on:
105
+ Issue tracking system (e.g., GitHub issues)
106
+ Pull request guidelines
107
+ Coding style and conventions
108
+ Testing requirements
109
+
110
+ #### Community and Support:
111
+
112
+ Specify available resources for users to seek help and engage with the community. This could include:
113
+ Official channels (e.g., discussion forums, mailing lists)
114
+ Third-party resources (e.g., Stack Overflow tags, community blogs)
115
+
116
+ #### License:
117
+
118
+ Clearly state the license under which your framework is distributed.
119
+
120
+ #### Additional Tips:
121
+
122
+ Maintain a clear and concise writing style, using easy-to-understand language.
123
+ Ensure proper formatting and structure for readability.
124
+ Provide code snippets in a visually appealing format, using code blocks and syntax highlighting.
125
+ Consider adding screenshots or diagrams to illustrate complex concepts.
126
+ Regularly update the guide with new features, bug fixes, and best practices.
127
+
@@ -0,0 +1,58 @@
1
+ neuroglia/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ neuroglia/core/__init__.py,sha256=MIYU40bW7XIp6FYAOdUcV9oirOBGISMApiVPPgsoVX4,118
3
+ neuroglia/core/module_loader.py,sha256=aKql4lNhdiPfnHTlbbcVMetZnexOB9e1MjDESL_bBN8,303
4
+ neuroglia/core/operation_result.py,sha256=bnIlP7_YkFMkpILaoi4C4XmR7kxjKvCQIxG1nnzfXWE,344
5
+ neuroglia/core/problem_details.py,sha256=_IdZi_MTxiX9mfwqapax8rVLjnBGtyefNdYxMmWL0xc,814
6
+ neuroglia/core/type_extensions.py,sha256=R1FnlR79uJcRtkO6s6doqmSi4U0Q0uim__nWP3QjF4I,4431
7
+ neuroglia/core/type_finder.py,sha256=APNBfa8f6pk9Z4FZaDIXu7OPLtflj3zQRWZodN31BWo,1565
8
+ neuroglia/data/__init__.py,sha256=YQeNZEWkJU1QfwxNeANyF3rkZ7DcvHc1KiiRQ6Jo4fs,24
9
+ neuroglia/data/abstractions.py,sha256=J3H82_uB1irf3_GvL0D37bho_XM7vNjCBQ2AY6EFxsA,3865
10
+ neuroglia/data/infrastructure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
11
+ neuroglia/data/infrastructure/abstractions.py,sha256=-mIm9aL94GsejiVGviNi6DBPy09ool0g3k-ZRi4LziI,2924
12
+ neuroglia/data/infrastructure/event_sourcing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
13
+ neuroglia/data/infrastructure/event_sourcing/abstractions.py,sha256=BCOF-Xpkf3bHixBqM_6ueqvYGApTyKvp2KHRHEJwR9I,4227
14
+ neuroglia/data/infrastructure/event_sourcing/event_sourcing_repository.py,sha256=oviPw4I5CacZ8mVNjUPmi_ooWbPliD7TcIRtfb8VWt4,3951
15
+ neuroglia/data/infrastructure/event_sourcing/event_store/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
16
+ neuroglia/data/infrastructure/event_sourcing/event_store/event_store.py,sha256=8z47MCagnfjyoZC7ZV78i16Vk5NUajwbDTu4OaPOWV8,9388
17
+ neuroglia/data/infrastructure/event_sourcing/read_model_reconciliator.py,sha256=JvTc1XUzXSI2VkFZ9M0SjTBXTibWn4zZJXtB2Z6vji4,2489
18
+ neuroglia/data/infrastructure/memory/__init__.py,sha256=dmQJmgzSChdvKFK_RdJBIrDElWZcbYfYBjfNRUKOsmk,67
19
+ neuroglia/data/infrastructure/memory/memory_repository.py,sha256=biqMqav5nDmE1QA1CneWnT1O-en0AlBQiIGeUZ-2TNw,905
20
+ neuroglia/data/infrastructure/mongo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
21
+ neuroglia/data/infrastructure/mongo/mongo_repository.py,sha256=JDBk7525W4D_pqjeNZFapQJDPGKeVntrsnBVfP6zCFM,17152
22
+ neuroglia/data/queries/generic/__init__.py,sha256=x0_HfnY1_9sYPVxk8AQFrW-iq8NpGoUhHNuMwX5ZhBE,56
23
+ neuroglia/data/queries/generic/get_by_id_query.py,sha256=EkPLrlumtGbgVXFOwFXgM8WJN5eyzX5Ivlag-LBoefw,1189
24
+ neuroglia/data/queries/generic/list_query.py,sha256=nT-1MgrOCHXJwL62mdwB_H_eU2k3PSPshJA0POg7mSQ,959
25
+ neuroglia/data/queryable.py,sha256=U3wtk4TcMf8K3SyXNiK1VZmS4v8AxmY3nh4Fwj4viy8,9211
26
+ neuroglia/dependency_injection/__init__.py,sha256=tB4ZK88ZFcz0Z7I7sFZc6Ob9f5dMqWj_vDTef21tPZA,31
27
+ neuroglia/dependency_injection/service_provider.py,sha256=HROO9zO84yHORkoIZuyP1g4o-jVGimuH3DYCaPtScKY,19410
28
+ neuroglia/eventing/cloud_events/__init__.py,sha256=v-QQ7TAvtpcvk3JjbyRLEIuwApiSFvavWStR70cotmc,49
29
+ neuroglia/eventing/cloud_events/cloud_event.py,sha256=u9ZzDyvazFQKdbNvyn-gOw0LteeSamEZ_O9_wpUik6g,3397
30
+ neuroglia/eventing/cloud_events/decorators.py,sha256=VmmJX1J47M8io_slzG3O_AZRvPkeDppT_LZsyr47mVA,155
31
+ neuroglia/eventing/cloud_events/infrastructure/__init__.py,sha256=SWClIn7XCmcpbkzUmYyLMChZMqlRPATn4aU2hzetcBY,208
32
+ neuroglia/eventing/cloud_events/infrastructure/cloud_event_bus.py,sha256=fSkdYoyyTjjdjwpwAR9JQGTBw3TWTT2rbZ7NtQrVt-M,377
33
+ neuroglia/eventing/cloud_events/infrastructure/cloud_event_ingestor.py,sha256=9zSi8NChA4r9ZHBOPD-S6kf42NhTIyezfp8wnOy3ovw,3514
34
+ neuroglia/eventing/cloud_events/infrastructure/cloud_event_middleware.py,sha256=eKOCFdce9R0SKpJEZkZU4Q9BQ_OYMtouLcBpuyrLezA,1886
35
+ neuroglia/eventing/cloud_events/infrastructure/cloud_event_publisher.py,sha256=e_4bOIZorDmT9X59mw1EunjczxO99MmXHcLl2UfJUp4,5004
36
+ neuroglia/expressions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
37
+ neuroglia/expressions/javascript_expression_translator.py,sha256=51krd6zAaKkMbsE7B38NzP-wrLT_iukOx3y8LT5rR8s,7575
38
+ neuroglia/hosting/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
39
+ neuroglia/hosting/abstractions.py,sha256=rCfcAQdJeFExNNHdBSI40AUJ7afXD2xiAmYag6tLLEA,4512
40
+ neuroglia/hosting/configuration/data_access_layer.py,sha256=qpddcrcGjHf5dc6pS3-Og5QTy_1C-Z1jZyOzXr51X_c,3549
41
+ neuroglia/hosting/web.py,sha256=4cgrcKv11i5pCvF6BAvADDh61yhnngtG_MegKTETQzk,3853
42
+ neuroglia/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
43
+ neuroglia/integration/models.py,sha256=WQe0AfDBkaARq9cCvrNKwdqWK2MbLBPYvxlSOM2XgP4,562
44
+ neuroglia/mapping/__init__.py,sha256=aHGxWkILW84XNj_b_OSgqKQWH39fRdvbMKxbSmGYlV0,36
45
+ neuroglia/mapping/mapper.py,sha256=2Rjqo897pNvmMgF1WcIu_u-sWuScLQlOPeKt8Lq7HmQ,11023
46
+ neuroglia/mediation/__init__.py,sha256=OuWOVpeZXNCjc4aet9W0myZI6w8trD6c7tVaIojpfLw,23
47
+ neuroglia/mediation/mediator.py,sha256=Tpzk7sLFKa_B3eEvpatesZJX_-HSjbJpjeQNxWJOCno,8788
48
+ neuroglia/mvc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
49
+ neuroglia/mvc/controller_base.py,sha256=8dd4jDITxCAJ4a3-zuc-M_1bGhiDppRlnKwjKhMcavk,2900
50
+ neuroglia/reactive/__init__.py,sha256=-DJt-eZdeEkSS4qV6CECg_gokeLns0xQGUMhzj0Pse8,29
51
+ neuroglia/reactive/rx_async.py,sha256=3EGW-PykvnDtqKfWb3AX8nW1YojnVmN72lFHWi2hrQc,409
52
+ neuroglia/serialization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
53
+ neuroglia/serialization/abstractions.py,sha256=k-BYTnpIwvx7QPUOvxwzMz23YPEh8gGbuylY54LqDac,1063
54
+ neuroglia/serialization/json.py,sha256=qPcriQpFLIU7TBNTNTBUuNKsxFrJYQeM4eFCN-YpVBo,8792
55
+ neuroglia_python-0.0.23.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
56
+ neuroglia_python-0.0.23.dist-info/METADATA,sha256=tkZC1S1s1dvqpM_NVxkQlRUtDXwgp7JrwFqDQvDC2Yk,4435
57
+ neuroglia_python-0.0.23.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
58
+ neuroglia_python-0.0.23.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: poetry-core 1.9.1
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any