kontiki 1.0.1__tar.gz

kontiki-1.0.1/LICENSE

@@ -0,0 +1,177 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+

kontiki-1.0.1/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: kontiki
+Version: 1.0.1
+Summary: Microservices framework in Python.
+License: Apache-2.0
+License-File: LICENSE
+Author: Julien Weber
+Author-email: jpkwbr@protonmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: PyYAML (>=6.0,<7.0)
+Requires-Dist: aio-pika (>=9.0.0,<10.0.0)
+Requires-Dist: aiohttp (>=3.11.0,<4.0.0)
+Requires-Dist: pydantic (>=2.0.0,<3.0.0)
+Project-URL: Homepage, https://github.com/kontiki-org/kontiki
+Project-URL: Repository, https://github.com/kontiki-org/kontiki
+Description-Content-Type: text/markdown
+
+<img src="./assets/kontiki_logo.png" width="500">
+
+---
+## Overview
+
+**Kontiki** is a Python microservices framework built on **AMQP** (aio-pika) and asyncio.
+
+- **Write only your business logic**: Kontiki manages connections to RabbitMQ, message routing (RPC, events, sessions, broadcast), service lifecycle and configuration merge for you.
+- **Design service interactions as messages**: combine RPC, events, broadcast and per‑instance sessions to describe how services collaborate.
+- **Configuration‑driven**: merged YAML config and a unified runner (`cli.run`) to start services the same way in development and production.
+
+For a detailed overview of all features, see `docs/features.md`.
+
+---
+
+## Quickstart
+
+Install Kontiki (via pip or Poetry):
+
+```bash
+pip install kontiki
+```
+
+Define a simple service:
+
+```python
+from kontiki.delegate import ServiceDelegate
+from kontiki.messaging import Messenger, on_event, rpc
+
+
+class MyDelegate(ServiceDelegate):
+    async def setup(self):
+        # init from self.container.config
+        pass
+
+    async def start(self):
+        # optional: start background tasks / open connections
+        pass
+
+    async def stop(self):
+        # optional: stop background tasks / close connections
+        pass
+
+    def do_something(self, x):
+        # business logic
+        return x * 2
+
+    async def handle_thing(self, payload):
+        # business logic
+        return {"processed": payload}
+
+
+class MyService:
+    name = "compute-api"  # optional: if omitted, the class name "MyService" is used
+    delegate = MyDelegate()
+    messenger = Messenger()  # delegate: publish events, RPC to other services
+
+    @rpc
+    async def compute(self, x):
+        return self.delegate.do_something(x)
+
+    @on_event("thing_happened")
+    async def on_thing(self, payload):
+        result = await self.delegate.handle_thing(payload)
+        await self.messenger.publish("thing_processed", result)
+
+def run():
+    cli.run(MyService, "Example Kontiki service.", version="0.1.0")
+```
+
+Expose it as a CLI command in `pyproject.toml`:
+
+```toml
+[tool.poetry.scripts]
+my_service = "myapp.main:run"
+```
+
+Run your service:
+
+```bash
+my_service --config config.yaml
+```
+
+> **Kontiki relies on RabbitMQ**. For local development and to run the examples, you can start a RabbitMQ instance via Docker with:
+>
+> ```bash
+> make run-amqp
+> ```
+
+---
+
+## Documentation
+
+- Features: `docs/features.md`
+- Configuration reference: `docs/configuration.md`
+- Example configuration: `docs/kontiki-config.example.yaml`
+- Contributing guidelines: `CONTRIBUTING.md`
+- License: `LICENSE`
+
+---
+
+## Examples
+
+Examples can be run via the `Makefile` (see targets such as `run-rpc-service`, `run-rpc-example`, `run-simple-events-service`, etc.).
+
+| Feature                                      | Example path                                                     |
+|----------------------------------------------|------------------------------------------------------------------|
+| Basic RPC                                    | `examples/rpc/`                                                  |
+| Simple events                                | `examples/events/simple/`                                        |
+| Broadcast events                             | `examples/events/broadcast/`                                     |
+| Event serialization                          | `examples/events/serialization/`                                 |
+| Session-based events                         | `examples/events/session/`                                       |
+| Periodic tasks                               | `examples/task/`                                                 |
+| Service registry (admin + client)            | `examples/registry/`                                             |
+| Heartbeats & degraded mode                   | `examples/heartbeat/`                                            |
+| HTTP entrypoints                             | `examples/http/simple/`                                          |
+
+You can also have a look at the following repository [**kontiki-scheduler**](https://github.com/kontiki-org/kontiki-scheduler). It's an example scheduler service built with Kontiki.
+
+---
+
+## Misc
+
+*Kontiki did not come out of a naming workshop but from the album [*Kontiki*](https://cottonmather.bandcamp.com/album/kontiki) by the band Cotton Mather.  
+If you enjoy vintage 4-track indie pop as much as microservices, you should check it out.*
+

kontiki-1.0.1/README.md

@@ -0,0 +1,125 @@
+<img src="./assets/kontiki_logo.png" width="500">
+
+---
+## Overview
+
+**Kontiki** is a Python microservices framework built on **AMQP** (aio-pika) and asyncio.
+
+- **Write only your business logic**: Kontiki manages connections to RabbitMQ, message routing (RPC, events, sessions, broadcast), service lifecycle and configuration merge for you.
+- **Design service interactions as messages**: combine RPC, events, broadcast and per‑instance sessions to describe how services collaborate.
+- **Configuration‑driven**: merged YAML config and a unified runner (`cli.run`) to start services the same way in development and production.
+
+For a detailed overview of all features, see `docs/features.md`.
+
+---
+
+## Quickstart
+
+Install Kontiki (via pip or Poetry):
+
+```bash
+pip install kontiki
+```
+
+Define a simple service:
+
+```python
+from kontiki.delegate import ServiceDelegate
+from kontiki.messaging import Messenger, on_event, rpc
+
+
+class MyDelegate(ServiceDelegate):
+    async def setup(self):
+        # init from self.container.config
+        pass
+
+    async def start(self):
+        # optional: start background tasks / open connections
+        pass
+
+    async def stop(self):
+        # optional: stop background tasks / close connections
+        pass
+
+    def do_something(self, x):
+        # business logic
+        return x * 2
+
+    async def handle_thing(self, payload):
+        # business logic
+        return {"processed": payload}
+
+
+class MyService:
+    name = "compute-api"  # optional: if omitted, the class name "MyService" is used
+    delegate = MyDelegate()
+    messenger = Messenger()  # delegate: publish events, RPC to other services
+
+    @rpc
+    async def compute(self, x):
+        return self.delegate.do_something(x)
+
+    @on_event("thing_happened")
+    async def on_thing(self, payload):
+        result = await self.delegate.handle_thing(payload)
+        await self.messenger.publish("thing_processed", result)
+
+def run():
+    cli.run(MyService, "Example Kontiki service.", version="0.1.0")
+```
+
+Expose it as a CLI command in `pyproject.toml`:
+
+```toml
+[tool.poetry.scripts]
+my_service = "myapp.main:run"
+```
+
+Run your service:
+
+```bash
+my_service --config config.yaml
+```
+
+> **Kontiki relies on RabbitMQ**. For local development and to run the examples, you can start a RabbitMQ instance via Docker with:
+>
+> ```bash
+> make run-amqp
+> ```
+
+---
+
+## Documentation
+
+- Features: `docs/features.md`
+- Configuration reference: `docs/configuration.md`
+- Example configuration: `docs/kontiki-config.example.yaml`
+- Contributing guidelines: `CONTRIBUTING.md`
+- License: `LICENSE`
+
+---
+
+## Examples
+
+Examples can be run via the `Makefile` (see targets such as `run-rpc-service`, `run-rpc-example`, `run-simple-events-service`, etc.).
+
+| Feature                                      | Example path                                                     |
+|----------------------------------------------|------------------------------------------------------------------|
+| Basic RPC                                    | `examples/rpc/`                                                  |
+| Simple events                                | `examples/events/simple/`                                        |
+| Broadcast events                             | `examples/events/broadcast/`                                     |
+| Event serialization                          | `examples/events/serialization/`                                 |
+| Session-based events                         | `examples/events/session/`                                       |
+| Periodic tasks                               | `examples/task/`                                                 |
+| Service registry (admin + client)            | `examples/registry/`                                             |
+| Heartbeats & degraded mode                   | `examples/heartbeat/`                                            |
+| HTTP entrypoints                             | `examples/http/simple/`                                          |
+
+You can also have a look at the following repository [**kontiki-scheduler**](https://github.com/kontiki-org/kontiki-scheduler). It's an example scheduler service built with Kontiki.
+
+---
+
+## Misc
+
+*Kontiki did not come out of a naming workshop but from the album [*Kontiki*](https://cottonmather.bandcamp.com/album/kontiki) by the band Cotton Mather.  
+If you enjoy vintage 4-track indie pop as much as microservices, you should check it out.*

kontiki-1.0.1/kontiki/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+
+__version__ = "1.0.1"

kontiki-1.0.1/kontiki/configuration/__init__.py

@@ -0,0 +1,6 @@
+from kontiki.configuration.parameter import get_kontiki_parameter, get_parameter
+
+__all__ = [
+    "get_kontiki_parameter",
+    "get_parameter",
+]

kontiki-1.0.1/kontiki/configuration/configuration.py

@@ -0,0 +1,23 @@
+DEFAULT_LOGGING_CONFIGURATION = {
+    "version": 1,
+    "disable_existing_loggers": True,
+    "formatters": {
+        "default": {
+            "format": (
+                "%(asctime)s - %(name)s - %(levelname)s - %(message)s -"
+                " %(filename)s:%(lineno)d"
+            )
+        },
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "default",
+            "level": "DEBUG",
+        }
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "DEBUG",
+    },
+}

kontiki-1.0.1/kontiki/configuration/merge.py

@@ -0,0 +1,59 @@
+import yaml
+
+from kontiki.utils import log
+
+# -----------------------------------------------------------------------------
+
+
+class ConfigMergeError(Exception):
+    pass
+
+
+def merge(config_files):
+    def _smart_merge(d1, d2):
+        shared_keys = d1.keys() & d2.keys()
+        only_keys_2 = d2.keys() - d1.keys()
+        for key in only_keys_2:
+            d1[key] = d2[key]
+        errors = []
+        warnings = []
+
+        for key in shared_keys:
+            if isinstance(d1[key], dict) and isinstance(d2[key], dict):
+                suberrors, subwarnings = _smart_merge(d1[key], d2[key])
+                subwarnings = [f"{key}:{subkey}" for subkey in subwarnings]
+                suberrors = [f"{key}:{subkey}" for subkey in suberrors]
+
+                errors += suberrors
+                warnings += subwarnings
+
+            else:
+                if d1[key] == d2[key]:
+                    warnings.append(key)
+                else:
+                    errors.append(key)
+
+        return errors, warnings
+
+    config = {}
+    for config_file in config_files:
+        with open(config_file, "r", encoding="utf-8") as file:
+            tmp_dict = yaml.load(file, Loader=yaml.FullLoader)
+
+            if tmp_dict is None:
+                tmp_dict = {}
+            errors, warnings = _smart_merge(config, tmp_dict)
+            if errors:
+                for param in errors:
+                    log.error("%s definition is inconsistent.", param)
+                msg = (
+                    "Configuration file merge has failed due to param"
+                    " definition inconsistency."
+                )
+                raise ConfigMergeError(msg)
+            if warnings:
+                for param in warnings:
+                    msg = "%s is defined twice with the same value."
+                    log.warning(msg, param)
+
+    return config

kontiki-1.0.1/kontiki/configuration/parameter.py

@@ -0,0 +1,57 @@
+from kontiki.utils import KONTIKI, log
+
+# -----------------------------------------------------------------------------
+
+_MISSING = object()
+
+
+class ConfigParameterError(Exception):
+    pass
+
+
+class ConfigParameter:
+    def __init__(self, path_or_key):
+        self.path_or_key = path_or_key
+
+    def get(self, config, default=_MISSING):
+        keys = self.path_or_key.split(".")
+        try:
+            value = config
+            for key in keys:
+                value = value[key]
+            return value
+        except KeyError as err:
+            if default is not _MISSING:
+                msg = "No parameter %s defined in configuration. Use default value %s"
+                log.info(msg, self.path_or_key, default)
+                return default
+            raise ConfigParameterError(
+                f"Configuration paramater path {self.path_or_key} not found."
+            ) from err
+
+
+def resolve_parameter_path(config, path_or_key, use_config):
+    if use_config:
+        return ConfigParameter(path_or_key).get(config)
+    return path_or_key
+
+
+def get_kontiki_parameter(config, path, default=_MISSING):
+    return get_parameter(config, f"{KONTIKI}.{path}", default)
+
+
+def get_parameter(config, path, default=_MISSING):
+    try:
+        if config:
+            return ConfigParameter(path).get(config, default)
+        if default is not None:
+            msg = "No parameter %s defined in configuration. Use default value %s"
+            log.info(msg, path, default)
+
+            return default
+        msg = "No configuration found. No default value provided."
+        log.error(msg)
+        raise ConfigParameterError(msg)
+    except Exception as e:
+        log.error(str(e))
+        raise e