mgraph-ai-service-cache-client 0.1.2__py3-none-any.whl

mgraph_ai_service_cache_client/__init__.py

@@ -0,0 +1,2 @@
+package_name = 'mgraph_ai_service_cache_client'
+path         = __path__[0]

mgraph_ai_service_cache_client/config.py

@@ -0,0 +1,6 @@
+from mgraph_ai_service_cache_client import package_name
+
+SERVICE_NAME                             = package_name
+FAST_API__TITLE                          = "MGraph AI Service Cache Client"
+FAST_API__DESCRIPTION                    = "Base template for MGraph-AI microservices"
+LAMBDA_DEPENDENCIES__FAST_API_SERVERLESS = ['osbot-fast-api-serverless==v1.2.0']

mgraph_ai_service_cache_client/fast_api/Cache_Client__Fast_API.py

@@ -0,0 +1,15 @@
+from osbot_fast_api_serverless.fast_api.Serverless__Fast_API         import Serverless__Fast_API
+from mgraph_ai_service_cache_client.fast_api.routes.Routes__Info     import Routes__Info
+from mgraph_ai_service_cache_client.utils.Version                    import version__mgraph_ai_service_cache_client
+
+
+
+class Cache_Client__Fast_API(Serverless__Fast_API):
+    title   = "ASd"  #     FAST_API__TITLE
+    version = version__mgraph_ai_service_cache_client
+
+    def setup_routes(self):
+        self.add_routes(Routes__Info  )
+
+
+

mgraph_ai_service_cache_client/fast_api/lambda_handler.py

@@ -0,0 +1,26 @@
+import os
+
+if os.getenv('AWS_REGION'):  # only execute if we are not running inside an AWS Lambda function
+
+    from osbot_aws.aws.lambda_.boto3__lambda import load_dependencies       # using the lightweight file (which only has the boto3 calls required to load_dependencies)
+    LAMBDA_DEPENDENCIES =  ['osbot-fast-api-serverless==v1.2.0']
+
+    load_dependencies(LAMBDA_DEPENDENCIES)
+
+    def clear_osbot_modules():                            # todo: add this to load_dependencies method, since after it runs we don't need the osbot_aws.aws.lambda_.boto3__lambda
+        import sys
+        for module in list(sys.modules):
+            if module.startswith('osbot_aws'):
+                del sys.modules[module]
+
+    clear_osbot_modules()
+
+from mgraph_ai_service_cache_client.fast_api.Cache_Client__Fast_API import Cache_Client__Fast_API
+
+with Cache_Client__Fast_API() as _:
+    _.setup()
+    handler = _.handler()
+    app     = _.app()
+
+def run(event, context=None):
+    return handler(event, context)

mgraph_ai_service_cache_client/fast_api/routes/Routes__Info.py

@@ -0,0 +1,32 @@
+from osbot_fast_api.api.routes.Fast_API__Routes                import Fast_API__Routes
+from mgraph_ai_service_cache_client.service.info.Service_Info  import Service_Info
+
+TAG__ROUTES_INFO                  = 'info'
+ROUTES_PATHS__INFO                = [ f'/{TAG__ROUTES_INFO}/health'  ,
+                                      f'/{TAG__ROUTES_INFO}/server'  ,
+                                      f'/{TAG__ROUTES_INFO}/status'  ,
+                                      f'/{TAG__ROUTES_INFO}/versions']
+ROUTES_INFO__HEALTH__RETURN_VALUE = {'status': 'ok'}
+
+class Routes__Info(Fast_API__Routes):
+    tag         : str          = 'info'
+    service_info: Service_Info
+
+    def health(self):
+        return ROUTES_INFO__HEALTH__RETURN_VALUE
+
+    def server(self):                                             # Get service versions
+        return self.service_info.server_info()
+
+    def status(self):                                               # Get service status information
+        return self.service_info.service_info()
+
+    def versions(self):                                             # Get service versions
+        return self.service_info.versions()
+
+
+    def setup_routes(self):
+        self.add_route_get(self.health  )
+        self.add_route_get(self.server  )
+        self.add_route_get(self.status  )
+        self.add_route_get(self.versions)

mgraph_ai_service_cache_client/service/info/Service_Info.py

@@ -0,0 +1,23 @@
+from osbot_fast_api.utils.Fast_API__Server_Info                                    import fast_api__server_info, Fast_API__Server_Info
+from osbot_utils.type_safe.Type_Safe                                               import Type_Safe
+from mgraph_ai_service_cache_client.service.info.schemas.Schema__Service__Status   import Schema__Service__Status, Enum__Service_Environment
+from mgraph_ai_service_cache_client.service.info.schemas.Schema__Server__Versions  import Schema__Server__Versions
+
+
+class Service_Info(Type_Safe):
+
+    def environment(self):                                                   # Determine current environment
+        import os
+        if os.getenv('AWS_REGION'):
+            return Enum__Service_Environment.aws_lambda
+        else:
+            return Enum__Service_Environment.local
+
+    def service_info(self) -> Schema__Service__Status:                               # Get current service status
+        return Schema__Service__Status(environment = self.environment())
+
+    def versions(self):
+        return Schema__Server__Versions()
+
+    def server_info(self) -> Fast_API__Server_Info:
+        return fast_api__server_info

mgraph_ai_service_cache_client/service/info/schemas/Enum__Service_Environment.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class Enum__Service_Environment(Enum):
+    aws_lambda : str = 'aws-lambda'
+    local      : str = 'local'

mgraph_ai_service_cache_client/service/info/schemas/Enum__Service_Status.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+class Enum__Service_Status(Enum):
+    operational : str = 'operational'
+    degraded    : str = 'degraded'

mgraph_ai_service_cache_client/service/info/schemas/Schema__Server__Versions.py

@@ -0,0 +1,15 @@
+from osbot_utils.type_safe.Type_Safe                                            import Type_Safe
+from osbot_utils.type_safe.primitives.domains.common.safe_str.Safe_Str__Version import Safe_Str__Version
+from osbot_utils.utils.Version                                                  import Version as Version__OSBot_Utils
+from osbot_aws.utils.Version                                                    import Version as Version__OSBot_AWS
+from osbot_fast_api.utils.Version                                               import version__osbot_fast_api
+from osbot_fast_api_serverless.utils.Version                                    import version__osbot_fast_api_serverless
+from mgraph_ai_service_cache_client.utils.Version                               import version__mgraph_ai_service_cache_client
+
+
+class Schema__Server__Versions(Type_Safe):
+    mgraph_ai_service_cache_client : Safe_Str__Version = version__mgraph_ai_service_cache_client
+    osbot_utils                    : Safe_Str__Version = Safe_Str__Version(Version__OSBot_Utils().value()    )
+    osbot_aws                      : Safe_Str__Version = Safe_Str__Version(Version__OSBot_AWS  ().value()    )
+    osbot_fast_api                 : Safe_Str__Version = Safe_Str__Version(version__osbot_fast_api           )
+    osbot_fast_api_serverless      : Safe_Str__Version = Safe_Str__Version(version__osbot_fast_api_serverless)

mgraph_ai_service_cache_client/service/info/schemas/Schema__Service__Status.py

@@ -0,0 +1,14 @@
+
+from osbot_utils.type_safe.Type_Safe                                                import Type_Safe
+from osbot_utils.type_safe.primitives.domains.common.safe_str.Safe_Str__Version     import Safe_Str__Version
+from osbot_utils.type_safe.primitives.domains.identifiers.Safe_Id                   import Safe_Id
+from mgraph_ai_service_cache_client.config                                          import SERVICE_NAME
+from mgraph_ai_service_cache_client.service.info.schemas.Enum__Service_Environment  import Enum__Service_Environment
+from mgraph_ai_service_cache_client.service.info.schemas.Enum__Service_Status       import Enum__Service_Status
+from mgraph_ai_service_cache_client.utils.Version                                   import version__mgraph_ai_service_cache_client
+
+class Schema__Service__Status(Type_Safe):
+    name        : Safe_Id                   = Safe_Id(SERVICE_NAME)
+    version     : Safe_Str__Version         = version__mgraph_ai_service_cache_client
+    status      : Enum__Service_Status      = Enum__Service_Status.operational
+    environment : Enum__Service_Environment = Enum__Service_Environment.local

mgraph_ai_service_cache_client/utils/Version.py

@@ -0,0 +1,21 @@
+import mgraph_ai_service_cache_client
+from osbot_utils.type_safe.primitives.domains.common.safe_str.Safe_Str__Version import Safe_Str__Version
+from osbot_utils.type_safe.Type_Safe                                            import Type_Safe
+from osbot_utils.utils.Files                                                    import file_contents, path_combine
+
+
+class Version(Type_Safe):
+
+    FILE_NAME_VERSION = 'version'
+
+    def path_code_root(self):
+        return mgraph_ai_service_cache_client.path
+
+    def path_version_file(self):
+        return path_combine(self.path_code_root(), self.FILE_NAME_VERSION)
+
+    def value(self):
+        version = file_contents(self.path_version_file()) or ""
+        return Safe_Str__Version(version)
+
+version__mgraph_ai_service_cache_client = Version().value()

mgraph_ai_service_cache_client/utils/deploy/Deploy__Service.py

@@ -0,0 +1,20 @@
+from osbot_fast_api_serverless.deploy.Deploy__Serverless__Fast_API  import Deploy__Serverless__Fast_API
+from mgraph_ai_service_cache_client.config                                  import SERVICE_NAME, LAMBDA_DEPENDENCIES__FAST_API_SERVERLESS
+from mgraph_ai_service_cache_client.fast_api.lambda_handler                 import run
+
+class Deploy__Service(Deploy__Serverless__Fast_API):
+
+    def deploy_lambda(self):
+        with super().deploy_lambda() as _:
+            # Add any service-specific environment variables here
+            # Example: _.set_env_variable('BASE_API_KEY', get_env('BASE_API_KEY'))
+            return _
+
+    def handler(self):
+        return run
+
+    def lambda_dependencies(self):
+        return LAMBDA_DEPENDENCIES__FAST_API_SERVERLESS
+
+    def lambda_name(self):
+        return SERVICE_NAME

mgraph_ai_service_cache_client/version

@@ -0,0 +1 @@
+v0.1.2

mgraph_ai_service_cache_client-0.1.2.dist-info/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 [yyyy] [name of copyright owner]
+
+   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.

mgraph_ai_service_cache_client-0.1.2.dist-info/METADATA

@@ -0,0 +1,346 @@
+Metadata-Version: 2.1
+Name: mgraph_ai_service_cache__client
+Version: 0.1.2
+Summary: MGraph-AI__Service__Cache__Client
+Home-page: https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client
+License: Apache 2.0
+Author: Dinis Cruz
+Author-email: dinis.cruz@owasp.org
+Requires-Python: >=3.12,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: osbot-fast-api-serverless
+Project-URL: Repository, https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client
+Description-Content-Type: text/markdown
+
+# MGraph AI Service Cache Client
+
+[![Current Release](https://img.shields.io/badge/release-v0.1.2-blue)](https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client/releases)
+[![Python](https://img.shields.io/badge/python-3.12-blue)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.116.1-009688)](https://fastapi.tiangolo.com/)
+[![AWS Lambda](https://img.shields.io/badge/AWS-Lambda-orange)](https://aws.amazon.com/lambda/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
+[![CI Pipeline - DEV](https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client/actions/workflows/ci-pipeline__dev.yml/badge.svg)](https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client/actions)
+
+A production-ready FastAPI microservice template for building MGraph-AI services. This template provides a complete scaffold with CI/CD pipeline, AWS Lambda deployment, and type-safe architecture.
+
+## 🎯 Purpose
+
+This repository serves as the base template for creating new MGraph-AI services. It includes:
+- ✅ Complete FastAPI application structure  
+- ✅ Multi-stage CI/CD pipeline (dev, qa, prod)
+- ✅ AWS Lambda deployment configuration
+- ✅ Type-safe architecture using OSBot-Utils
+- ✅ Comprehensive test coverage
+- ✅ API key authentication
+- ✅ Health check and monitoring endpoints
+
+**Note**: This is a template repository. To create your own service, see [Creating Services from Template](docs/dev/non-functional-requirements/version-1_0_0/README.md).
+
+## 📚 Creating a New Service
+
+To create a new service from this template, see [Creating Services from MGraph-AI__Service__Cache__Client](docs/dev/non-functional-requirements/version-1_0_0/README.md).
+
+## 🚀 Features
+
+- **Type-Safe Architecture**: Built on OSBot-Utils type safety framework
+- **Multi-Stage Deployment**: Automated CI/CD pipeline for dev, QA, and production
+- **AWS Lambda Ready**: Optimized for serverless deployment
+- **API Key Authentication**: Secure access control
+
+## 📋 Table of Contents
+
+- [Quick Start](#-quick-start)
+- [Installation](#-installation)
+- [API Documentation](#-api-documentation)
+- [Configuration](#-configuration)
+- [Development](#-development)
+- [Testing](#-testing)
+- [Deployment](#-deployment)
+- [Security](#-security)
+- [Contributing](#-contributing)
+- [License](#-license)
+
+## 🎯 Quick Start
+
+### Local Development
+
+```bash
+# Clone the repository
+git clone https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client.git
+cd MGraph-AI__Service__Cache__Client
+
+# Install dependencies
+pip install -r requirements-test.txt
+pip install -e .
+
+# Set environment variables
+export FAST_API__AUTH__API_KEY__NAME="x-api-key"
+export FAST_API__AUTH__API_KEY__VALUE="your-secret-key"
+
+# Run locally
+./scripts/run-locally.sh
+# or
+uvicorn mgraph_ai_service_cache__client.fast_api.lambda_handler:app --reload --host 0.0.0.0 --port 10011
+```
+
+### Basic Usage
+
+```python
+import requests
+
+# Set up authentication
+headers = {"x-api-key": "your-secret-key"}
+base_url = "http://localhost:10011"
+
+# Check service health
+response = requests.get(f"{base_url}/health", headers=headers)
+print(response.json())
+
+# Get service info
+response = requests.get(f"{base_url}/info/version", headers=headers)
+print(response.json())
+```
+
+## 📦 Installation
+
+### Prerequisites
+
+- Python 3.12+
+- AWS CLI (for deployment)
+- Docker (for LocalStack testing)
+
+### Using Poetry
+
+```bash
+# Install poetry if not already installed
+pip install poetry
+
+# Install dependencies
+poetry install
+
+# Activate virtual environment
+poetry shell
+```
+
+### Using pip
+
+```bash
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements-test.txt
+pip install -e .
+```
+
+## 📖 API Documentation
+
+### Interactive API Documentation
+
+Once the service is running, access the interactive API documentation at:
+- Swagger UI: http://localhost:10011/docs
+- ReDoc: http://localhost:10011/redoc
+
+### Endpoints Overview
+
+#### Health Endpoints
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/health` | GET | Service health check |
+| `/health/detailed` | GET | Detailed health status |
+
+#### Information Endpoints
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/info/version` | GET | Get service version |
+| `/info/status` | GET | Get service status |
+
+## ⚙️ Configuration
+
+### Environment Variables
+
+| Variable | Description | Required | Default |
+|----------|-------------|----------|---------|
+| `FAST_API__AUTH__API_KEY__NAME` | Header name for API key | Yes | - |
+| `FAST_API__AUTH__API_KEY__VALUE` | API key value | Yes | - |
+| `AWS_REGION` | AWS region (triggers Lambda mode) | No | - |
+| `DEBUG` | Enable debug logging | No | false |
+
+### Configuration File
+
+Create a `.env` file for local development:
+
+```env
+FAST_API__AUTH__API_KEY__NAME=x-api-key
+FAST_API__AUTH__API_KEY__VALUE=development-key-12345
+```
+
+## 🛠️ Development
+
+### Project Structure
+
+```
+mgraph_ai_service_cache__client/
+├── fast_api/
+│   ├── lambda_handler.py      # AWS Lambda entry point
+│   ├── Service__Fast_API.py   # FastAPI application setup
+│   └── routes/               # API endpoint definitions
+├── service/
+│   └── info/               # Service information
+├── utils/
+│   ├── deploy/             # Deployment utilities
+│   └── Version.py          # Version management
+└── config.py               # Service configuration
+```
+
+### Adding New Endpoints
+
+1. Create a new route class in `fast_api/routes/`:
+
+```python
+from osbot_fast_api.api.Fast_API_Routes import Fast_API_Routes
+
+class Routes__MyFeature(Fast_API_Routes):
+    tag = 'my-feature'
+    
+    def my_endpoint(self, param: str = "default"):
+        return {"result": param}
+    
+    def setup_routes(self):
+        self.add_route_get(self.my_endpoint)
+```
+
+2. Register in `Service__Fast_API`:
+
+```python
+def setup_routes(self):
+    # ... existing routes
+    self.add_routes(Routes__MyFeature)
+```
+
+## 🧪 Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=mgraph_ai_service_cache__client
+
+# Run specific test file
+pytest tests/unit/fast_api/test_Service__Fast_API__client.py
+
+# Run integration tests (requires LocalStack)
+pytest tests/integration/
+```
+
+### Test Structure
+
+```
+tests/
+├── unit/                    # Unit tests
+│   ├── fast_api/           # API tests
+│   └── service/            # Service tests
+└── deploy_aws/             # Deployment tests
+```
+
+## 🚀 Deployment
+
+### AWS Lambda Deployment
+
+The service includes automated deployment scripts for multiple environments:
+
+```bash
+# Deploy to development
+pytest tests/deploy_aws/test_Deploy__Service__to__dev.py
+
+# Deploy to QA
+pytest tests/deploy_aws/test_Deploy__Service__to__qa.py
+
+# Deploy to production (manual trigger)
+# Use GitHub Actions workflow
+```
+
+### CI/CD Pipeline
+
+The project uses GitHub Actions for continuous deployment:
+
+1. **Development Branch** (`dev`)
+   - Runs tests with LocalStack
+   - Deploys to dev environment
+   - Increments minor version
+
+2. **Main Branch** (`main`)
+   - Runs comprehensive test suite
+   - Deploys to QA environment
+   - Increments major version
+
+3. **Production** (manual)
+   - Requires manual workflow trigger
+   - Deploys to production environment
+
+## 🔒 Security
+
+### Authentication
+
+API key authentication is required for all endpoints:
+
+```python
+headers = {"x-api-key": "your-secret-key"}
+```
+
+### Best Practices
+
+1. **Never commit secrets** - Use environment variables
+2. **Rotate API keys** - Regular key rotation
+3. **Use HTTPS** - Always encrypt in transit
+4. **Monitor access** - Log and audit API usage
+
+## 🤝 Contributing
+
+We welcome contributions! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### Development Guidelines
+
+- Write tests for new features
+- Update documentation
+- Follow existing code style
+- Add type annotations
+- Consider security implications
+
+## 🔗 Related Projects
+
+- [OSBot-Utils](https://github.com/owasp-sbot/OSBot-Utils) - Core utilities library
+- [OSBot-AWS](https://github.com/owasp-sbot/OSBot-AWS) - AWS integration layer
+- [OSBot-Fast-API](https://github.com/owasp-sbot/OSBot-Fast-API) - FastAPI utilities
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- Built with [FastAPI](https://fastapi.tiangolo.com/)
+- Deployed on [AWS Lambda](https://aws.amazon.com/lambda/)
+
+## 📞 Support
+
+- 🐛 Issues: [GitHub Issues](https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client/issues)
+- 💬 Discussions: [GitHub Discussions](https://github.com/the-cyber-boardroom/MGraph-AI__Service__Cache__Client/discussions)
+
+---
+
+Created and maintained by [The Cyber Boardroom](https://github.com/the-cyber-boardroom) team

mgraph_ai_service_cache_client-0.1.2.dist-info/RECORD

@@ -0,0 +1,17 @@
+mgraph_ai_service_cache_client/__init__.py,sha256=vV-3_LTA0gOaz_M_rug9AA7UQ6vMFo35MolQSywHS-4,74
+mgraph_ai_service_cache_client/config.py,sha256=JmUXxVA2PmuPzv39_0751dswVYyUtrzAjVr1JFnso-s,356
+mgraph_ai_service_cache_client/fast_api/Cache_Client__Fast_API.py,sha256=iYUqCYKemXJPpSVDYJ5VAxcAZEqMIK5Q6CaWZ5uSGPE,526
+mgraph_ai_service_cache_client/fast_api/lambda_handler.py,sha256=hqBD4imnlACXdE7mFjUz7Q7OkxOoA1rk4blZ9HqsWaY,1001
+mgraph_ai_service_cache_client/fast_api/routes/Routes__Info.py,sha256=4Qe67YJeS6vAaFPTrefVFRnbBu3XaHDN9joWs49i1_4,1353
+mgraph_ai_service_cache_client/service/info/Service_Info.py,sha256=lTTZcqJ2cKjmtc1nulNKk77A1xz3zQWUG7EQsfh0ApQ,1154
+mgraph_ai_service_cache_client/service/info/schemas/Enum__Service_Environment.py,sha256=x4B6kDwncyklQaEFf0kAGyY5LE0r9Ch3ww_EZmBUDP8,129
+mgraph_ai_service_cache_client/service/info/schemas/Enum__Service_Status.py,sha256=15PehXAEwdvlG-axvTF-p8XYWklscLPucH1Ki2UrwTQ,129
+mgraph_ai_service_cache_client/service/info/schemas/Schema__Server__Versions.py,sha256=SGXNdZT_hrel-QV0AoNBsP4D42vGHgVNijiwb9RmZGw,1384
+mgraph_ai_service_cache_client/service/info/schemas/Schema__Service__Status.py,sha256=jlmwi37c1m_aDnKG7VMFzjoNbeb9AZNX45nVNksROrk,1127
+mgraph_ai_service_cache_client/utils/Version.py,sha256=-iKgWjUzrm9eGMdLFsvKPuxZFckmfNE5Y5bw6vSydhY,797
+mgraph_ai_service_cache_client/utils/deploy/Deploy__Service.py,sha256=iBqB4km1H3eHPXPfyh7UajjHMKom684S9ACGUa13vw4,816
+mgraph_ai_service_cache_client/version,sha256=DbJRHyaaVDZLLGEBuP-r4piScs6LbHtBdjThjRMnVaI,7
+mgraph_ai_service_cache_client-0.1.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+mgraph_ai_service_cache_client-0.1.2.dist-info/METADATA,sha256=EcQVBuPW5HmLg27sijBUC0F8HJVS8GUyoOMityVpSK0,9846
+mgraph_ai_service_cache_client-0.1.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mgraph_ai_service_cache_client-0.1.2.dist-info/RECORD,,

mgraph_ai_service_cache_client-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any