kbm-ledsas-sdk 0.3.2__tar.gz

kbm_ledsas_sdk-0.3.2/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025-2026 KeborMed
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kbm_ledsas_sdk-0.3.2/NOTICE

@@ -0,0 +1,9 @@
+KeborMed LEDSAS SDK
+Copyright 2025-2026 KeborMed
+
+This product includes software developed at KeborMed (https://kebormed.com).
+
+Licensed under the Apache License, Version 2.0 (see the LICENSE file).
+
+This product depends on third-party open-source software. See
+THIRD_PARTY_NOTICES.txt for the full list of dependencies and their licenses.

kbm_ledsas_sdk-0.3.2/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: kbm-ledsas-sdk
+Version: 0.3.2
+Summary: KeborMed LEDSAS SDK - Python client for building Local External Data Sources Action Service (LEDSAS) data-processing services
+Author-email: KeborMed <support@kebormed.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Kubyk-Health/kbm-ledsas-sdk
+Project-URL: Repository, https://github.com/Kubyk-Health/kbm-ledsas-sdk
+Project-URL: Issues, https://github.com/Kubyk-Health/kbm-ledsas-sdk/issues
+Project-URL: Changelog, https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CHANGELOG.md
+Keywords: ledsas,kebormed,rabbitmq,azure-blob,medical,data-processing,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pydantic<3.0,>=2.5.0
+Requires-Dist: aio-pika<10.0,>=9.4.0
+Requires-Dist: azure-storage-blob<13.0,>=12.19.0
+Requires-Dist: aiohttp<4.0,>=3.8.0
+Requires-Dist: cryptography>=48.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: ruff<0.15,>=0.5; extra == "dev"
+Requires-Dist: black<26,>=24.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Dynamic: license-file
+
+# KeborMed LEDSAS SDK (Python)
+
+[![CI](https://github.com/Kubyk-Health/kbm-ledsas-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Kubyk-Health/kbm-ledsas-sdk/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/kbm-ledsas-sdk.svg)](https://pypi.org/project/kbm-ledsas-sdk/)
+[![Python versions](https://img.shields.io/pypi/pyversions/kbm-ledsas-sdk.svg)](https://pypi.org/project/kbm-ledsas-sdk/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+A Python client SDK for building **LEDSAS** (Local External Data Sources Action Service)
+data-processing services. You write async handler functions; the SDK consumes command
+messages from **RabbitMQ**, runs your handler, reads and writes payloads in **Azure Blob
+Storage**, and (optionally) publishes the response back to the caller.
+
+It handles the plumbing — message consumption, acknowledgement, retries, timeouts,
+structured logging, health/readiness endpoints, and blob I/O — so your service code stays
+focused on the data transformation.
+
+---
+
+## Features
+
+- **Handler-based programming model** — register `async` handlers with a decorator.
+- **RabbitMQ consumption** with prefetch, bounded concurrency, ack/nack semantics, and a
+  dead-letter path for poison messages.
+- **Azure Blob Storage** helpers: `download_bytes/text/json/stream`, `upload_bytes/text/json`,
+  and memory-bounded streaming for large files.
+- **Typed models** (Pydantic v2) for blob references and message envelopes.
+- **Built-in retries & timeouts** with permanent vs. transient error classes.
+- **Health & readiness** HTTP endpoints (`/health`, `/ready`, `/livez`, `/readyz`) with
+  pluggable liveness/readiness checks.
+- **Structured JSON logging** out of the box.
+- **Fully type-hinted** (`py.typed`), Python 3.11+.
+
+## Installation
+
+```bash
+pip install kbm-ledsas-sdk
+```
+
+To work from a clone — or before a release is published to PyPI — install from source:
+
+```bash
+git clone https://github.com/Kubyk-Health/kbm-ledsas-sdk.git
+cd kbm-ledsas-sdk
+pip install -e .            # add "[dev]" for the test/lint toolchain: pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+import logging
+from kbm_ledsas_sdk import ServiceApp, errors
+
+logging.basicConfig(level=logging.INFO)
+
+app = ServiceApp(service_name="csv-processor")
+
+
+@app.handler("ProcessCSV")
+async def handle(ctx, req: dict) -> dict:
+    csv_uri = req.get("csv_uri")
+    if not csv_uri:
+        # user_message is what the caller sees; the internal message goes to logs.
+        raise errors.Permanent(
+            "Validation: csv_uri missing",
+            user_message="csv_uri is required",
+        )
+
+    text = await ctx.blob.download_text(csv_uri)
+    container = csv_uri.replace("azblob://", "").split("/", 1)[0]
+
+    out = await ctx.blob.upload_json(
+        container=container,
+        obj={"rows": len(text.splitlines()) - 1},
+        # Use idempotency_key (not message_id) so a redelivery of the same logical
+        # request overwrites the same blob. overwrite=True is required for that.
+        path=f"result-{ctx.idempotency_key}.json",
+        overwrite=True,
+    )
+    return {"result_uri": out.uri}
+
+
+# Optional readiness hook (the SDK ships sensible defaults; this layers on top).
+@app.readiness_check("warmup_done")
+def _() -> bool:
+    return True
+
+
+if __name__ == "__main__":
+    app.run()
+```
+
+Run it against a local RabbitMQ + Azure Blob (Azurite):
+
+```bash
+export KBM_LEDSAS_RABBITMQ_URL="amqp://guest:guest@127.0.0.1:5672/"
+export KBM_LEDSAS_BLOB_CONN_STRING="DefaultEndpointsProtocol=http;AccountName=...;AccountKey=...;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+python my_service.py
+```
+
+The service also exposes health endpoints at
+`http://127.0.0.1:8090/health` and `/ready` (loopback only by default; set
+`KBM_LEDSAS_HEALTH_HOST=0.0.0.0` to bind all interfaces).
+
+## Local development
+
+A ready-to-run stack (RabbitMQ + Azurite) is provided with the example service:
+
+```bash
+cd examples/hello_world_service
+pip install -e ../..                                        # install the SDK from this repo
+docker compose -f deploy/local/docker-compose.yml up -d     # start RabbitMQ + Azurite
+python main.py                                              # run the example service
+```
+
+See [`examples/hello_world_service/`](https://github.com/Kubyk-Health/kbm-ledsas-sdk/tree/main/examples/hello_world_service) for a complete,
+runnable service (handler, sender script, tests, `Dockerfile`, and a local
+`docker compose` stack under `deploy/local/`).
+
+## Configuration
+
+The SDK is configured through environment variables. The most common are below; see the [API reference](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/docs/SDK_API_REFERENCE.md#environment-variables) for the complete list (including `KBM_LEDSAS_ALLOW_INSECURE_AMQP`, `KBM_LEDSAS_MAX_PAYLOAD_BYTES`, and other advanced settings):
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `KBM_LEDSAS_SERVICE_NAME` | Service name used for message routing | *(required)* |
+| `KBM_LEDSAS_TENANT` | Tenant identifier | *(optional)* |
+| `KBM_LEDSAS_RABBITMQ_URL` | RabbitMQ connection URL | *(required)* |
+| `KBM_LEDSAS_BLOB_CONN_STRING` | Azure Blob Storage connection string | *(required)* |
+| `KBM_LEDSAS_CONTAINER` | Default blob container | `dev` |
+| `KBM_LEDSAS_PREFETCH` | AMQP prefetch count | `10` |
+| `KBM_LEDSAS_CONCURRENCY` | Worker concurrency | `4` |
+| `KBM_LEDSAS_HANDLER_TIMEOUT` | Per-handler timeout (seconds) | `1800` |
+| `KBM_LEDSAS_MAX_RETRIES` | Max retries for transient failures | `3` |
+| `KBM_LEDSAS_LOG_LEVEL` | Log level | `INFO` |
+| `KBM_LEDSAS_LOG_FORMAT` | Log format (`json` or `text`) | `json` |
+| `KBM_LEDSAS_HEALTH_HOST` | Health server bind host | `127.0.0.1` |
+| `KBM_LEDSAS_HEALTH_PORT` | Health server port | `8090` |
+| `KBM_LEDSAS_DEPLOYMENT_ID` | Build/commit id surfaced as `deployment_id` in `/health` and `/ready` | *(optional)* |
+
+## Documentation
+
+- [API Reference](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/docs/SDK_API_REFERENCE.md)
+- [Example service](https://github.com/Kubyk-Health/kbm-ledsas-sdk/tree/main/examples/hello_world_service)
+- [Changelog](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CHANGELOG.md)
+
+## Contributing
+
+Contributions are welcome! Please read [CONTRIBUTING.md](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CONTRIBUTING.md) first — it covers
+the development setup, how to run the tests, the coding style, and the **Developer Certificate
+of Origin (DCO)** sign-off we require on every commit. Also see our
+[Code of Conduct](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## Security
+
+Please report vulnerabilities privately — see [SECURITY.md](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/SECURITY.md). Do **not** open a
+public issue for security reports.
+
+## License
+
+Licensed under the [Apache License 2.0](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/LICENSE). Copyright © 2025-2026 KeborMed.
+See [THIRD_PARTY_NOTICES.txt](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/THIRD_PARTY_NOTICES.txt) for third-party dependency licenses.
+
+Maintained by **KeborMed** (the software's copyright holder) under the
+[**Kubyk-Health**](https://github.com/Kubyk-Health) GitHub organization.

kbm_ledsas_sdk-0.3.2/README.md

@@ -0,0 +1,164 @@
+# KeborMed LEDSAS SDK (Python)
+
+[![CI](https://github.com/Kubyk-Health/kbm-ledsas-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Kubyk-Health/kbm-ledsas-sdk/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/kbm-ledsas-sdk.svg)](https://pypi.org/project/kbm-ledsas-sdk/)
+[![Python versions](https://img.shields.io/pypi/pyversions/kbm-ledsas-sdk.svg)](https://pypi.org/project/kbm-ledsas-sdk/)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+A Python client SDK for building **LEDSAS** (Local External Data Sources Action Service)
+data-processing services. You write async handler functions; the SDK consumes command
+messages from **RabbitMQ**, runs your handler, reads and writes payloads in **Azure Blob
+Storage**, and (optionally) publishes the response back to the caller.
+
+It handles the plumbing — message consumption, acknowledgement, retries, timeouts,
+structured logging, health/readiness endpoints, and blob I/O — so your service code stays
+focused on the data transformation.
+
+---
+
+## Features
+
+- **Handler-based programming model** — register `async` handlers with a decorator.
+- **RabbitMQ consumption** with prefetch, bounded concurrency, ack/nack semantics, and a
+  dead-letter path for poison messages.
+- **Azure Blob Storage** helpers: `download_bytes/text/json/stream`, `upload_bytes/text/json`,
+  and memory-bounded streaming for large files.
+- **Typed models** (Pydantic v2) for blob references and message envelopes.
+- **Built-in retries & timeouts** with permanent vs. transient error classes.
+- **Health & readiness** HTTP endpoints (`/health`, `/ready`, `/livez`, `/readyz`) with
+  pluggable liveness/readiness checks.
+- **Structured JSON logging** out of the box.
+- **Fully type-hinted** (`py.typed`), Python 3.11+.
+
+## Installation
+
+```bash
+pip install kbm-ledsas-sdk
+```
+
+To work from a clone — or before a release is published to PyPI — install from source:
+
+```bash
+git clone https://github.com/Kubyk-Health/kbm-ledsas-sdk.git
+cd kbm-ledsas-sdk
+pip install -e .            # add "[dev]" for the test/lint toolchain: pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```python
+import logging
+from kbm_ledsas_sdk import ServiceApp, errors
+
+logging.basicConfig(level=logging.INFO)
+
+app = ServiceApp(service_name="csv-processor")
+
+
+@app.handler("ProcessCSV")
+async def handle(ctx, req: dict) -> dict:
+    csv_uri = req.get("csv_uri")
+    if not csv_uri:
+        # user_message is what the caller sees; the internal message goes to logs.
+        raise errors.Permanent(
+            "Validation: csv_uri missing",
+            user_message="csv_uri is required",
+        )
+
+    text = await ctx.blob.download_text(csv_uri)
+    container = csv_uri.replace("azblob://", "").split("/", 1)[0]
+
+    out = await ctx.blob.upload_json(
+        container=container,
+        obj={"rows": len(text.splitlines()) - 1},
+        # Use idempotency_key (not message_id) so a redelivery of the same logical
+        # request overwrites the same blob. overwrite=True is required for that.
+        path=f"result-{ctx.idempotency_key}.json",
+        overwrite=True,
+    )
+    return {"result_uri": out.uri}
+
+
+# Optional readiness hook (the SDK ships sensible defaults; this layers on top).
+@app.readiness_check("warmup_done")
+def _() -> bool:
+    return True
+
+
+if __name__ == "__main__":
+    app.run()
+```
+
+Run it against a local RabbitMQ + Azure Blob (Azurite):
+
+```bash
+export KBM_LEDSAS_RABBITMQ_URL="amqp://guest:guest@127.0.0.1:5672/"
+export KBM_LEDSAS_BLOB_CONN_STRING="DefaultEndpointsProtocol=http;AccountName=...;AccountKey=...;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+python my_service.py
+```
+
+The service also exposes health endpoints at
+`http://127.0.0.1:8090/health` and `/ready` (loopback only by default; set
+`KBM_LEDSAS_HEALTH_HOST=0.0.0.0` to bind all interfaces).
+
+## Local development
+
+A ready-to-run stack (RabbitMQ + Azurite) is provided with the example service:
+
+```bash
+cd examples/hello_world_service
+pip install -e ../..                                        # install the SDK from this repo
+docker compose -f deploy/local/docker-compose.yml up -d     # start RabbitMQ + Azurite
+python main.py                                              # run the example service
+```
+
+See [`examples/hello_world_service/`](https://github.com/Kubyk-Health/kbm-ledsas-sdk/tree/main/examples/hello_world_service) for a complete,
+runnable service (handler, sender script, tests, `Dockerfile`, and a local
+`docker compose` stack under `deploy/local/`).
+
+## Configuration
+
+The SDK is configured through environment variables. The most common are below; see the [API reference](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/docs/SDK_API_REFERENCE.md#environment-variables) for the complete list (including `KBM_LEDSAS_ALLOW_INSECURE_AMQP`, `KBM_LEDSAS_MAX_PAYLOAD_BYTES`, and other advanced settings):
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `KBM_LEDSAS_SERVICE_NAME` | Service name used for message routing | *(required)* |
+| `KBM_LEDSAS_TENANT` | Tenant identifier | *(optional)* |
+| `KBM_LEDSAS_RABBITMQ_URL` | RabbitMQ connection URL | *(required)* |
+| `KBM_LEDSAS_BLOB_CONN_STRING` | Azure Blob Storage connection string | *(required)* |
+| `KBM_LEDSAS_CONTAINER` | Default blob container | `dev` |
+| `KBM_LEDSAS_PREFETCH` | AMQP prefetch count | `10` |
+| `KBM_LEDSAS_CONCURRENCY` | Worker concurrency | `4` |
+| `KBM_LEDSAS_HANDLER_TIMEOUT` | Per-handler timeout (seconds) | `1800` |
+| `KBM_LEDSAS_MAX_RETRIES` | Max retries for transient failures | `3` |
+| `KBM_LEDSAS_LOG_LEVEL` | Log level | `INFO` |
+| `KBM_LEDSAS_LOG_FORMAT` | Log format (`json` or `text`) | `json` |
+| `KBM_LEDSAS_HEALTH_HOST` | Health server bind host | `127.0.0.1` |
+| `KBM_LEDSAS_HEALTH_PORT` | Health server port | `8090` |
+| `KBM_LEDSAS_DEPLOYMENT_ID` | Build/commit id surfaced as `deployment_id` in `/health` and `/ready` | *(optional)* |
+
+## Documentation
+
+- [API Reference](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/docs/SDK_API_REFERENCE.md)
+- [Example service](https://github.com/Kubyk-Health/kbm-ledsas-sdk/tree/main/examples/hello_world_service)
+- [Changelog](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CHANGELOG.md)
+
+## Contributing
+
+Contributions are welcome! Please read [CONTRIBUTING.md](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CONTRIBUTING.md) first — it covers
+the development setup, how to run the tests, the coding style, and the **Developer Certificate
+of Origin (DCO)** sign-off we require on every commit. Also see our
+[Code of Conduct](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## Security
+
+Please report vulnerabilities privately — see [SECURITY.md](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/SECURITY.md). Do **not** open a
+public issue for security reports.
+
+## License
+
+Licensed under the [Apache License 2.0](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/LICENSE). Copyright © 2025-2026 KeborMed.
+See [THIRD_PARTY_NOTICES.txt](https://github.com/Kubyk-Health/kbm-ledsas-sdk/blob/main/THIRD_PARTY_NOTICES.txt) for third-party dependency licenses.
+
+Maintained by **KeborMed** (the software's copyright holder) under the
+[**Kubyk-Health**](https://github.com/Kubyk-Health) GitHub organization.