inter-service-sdk 1.0.2__tar.gz

inter_service_sdk-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Blazel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

inter_service_sdk-1.0.2/PKG-INFO

@@ -0,0 +1,332 @@
+Metadata-Version: 2.4
+Name: inter-service-sdk
+Version: 1.0.2
+Summary: Complete framework for inter-service communication with client, server utilities, auth and encryption
+Home-page: https://github.com/AlexanderRyzhko/inter-service-sdk
+Author: Blazel
+Author-email: Blazel <dev@blazel.com>
+Project-URL: Homepage, https://github.com/AlexanderRyzhko/inter-service-sdk
+Project-URL: Bug Tracker, https://github.com/AlexanderRyzhko/inter-service-sdk/issues
+Project-URL: Documentation, https://github.com/AlexanderRyzhko/inter-service-sdk#readme
+Project-URL: Source Code, https://github.com/AlexanderRyzhko/inter-service-sdk
+Keywords: http,client,server,api,rest,fastapi,inter-service,microservices,authentication,encryption,ecc,bearer-token
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: fastapi>=0.104.0
+Provides-Extra: crypto
+Requires-Dist: cryptography>=41.0.0; extra == "crypto"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.11.1; extra == "dev"
+Requires-Dist: requests-mock>=1.11.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.1.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: types-requests>=2.31.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: cryptography>=41.0.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Inter-Service SDK
+
+Generic HTTP client for secure service-to-service communication with bearer token authentication and optional ECC encryption.
+
+## Features
+
+- 🔐 **Bearer Token Auth** - Automatic authentication headers
+- 🔒 **Optional ECC Encryption** - End-to-end encryption for sensitive data
+- 🎯 **Path & Query Parameters** - Clean parameter substitution
+- 🔄 **Automatic Retries** - Exponential backoff for failed requests
+- 📝 **Structured Logging** - Request/response tracking
+- 🚀 **Zero Dependencies** - Only requests and cryptography (optional)
+
+## Installation
+
+```bash
+pip install inter-service-sdk
+```
+
+## Quick Start
+
+```python
+from inter_service_sdk import InterServiceClient
+
+# Initialize client
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-secret-key"
+)
+
+# Make a request
+response = client.request(
+    endpoint="users/{user_id}",
+    path_params={"user_id": 123}
+)
+
+print(response["data"])
+```
+
+## Usage
+
+### Basic GET Request
+
+```python
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-api-key"
+)
+
+# GET /api/v1/inter-service/users/123
+user = client.request(
+    endpoint="users/{user_id}",
+    path_params={"user_id": 123}
+)
+```
+
+### With Query Parameters
+
+```python
+# GET /api/v1/inter-service/users/search?q=john&type=email&limit=10
+results = client.request(
+    endpoint="users/search",
+    query_params={
+        "q": "john",
+        "type": "email",
+        "limit": 10
+    }
+)
+```
+
+### POST Request
+
+```python
+# POST /api/v1/inter-service/users
+new_user = client.request(
+    endpoint="users",
+    method="POST",
+    data={
+        "name": "John Doe",
+        "email": "john@example.com"
+    }
+)
+```
+
+### With ECC Encryption
+
+```python
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-api-key",
+    ecc_private_key=os.getenv("PRIVATE_KEY"),
+    ecc_public_key=os.getenv("PUBLIC_KEY")
+)
+
+# Auto-decrypt response
+credentials = client.request(
+    endpoint="credentials/{id}",
+    path_params={"id": 456},
+    decrypt=True
+)
+
+# Auto-encrypt request
+client.request(
+    endpoint="secrets",
+    method="POST",
+    data={"secret": "sensitive data"},
+    encrypt=True
+)
+```
+
+### Custom API Prefix
+
+```python
+# Default prefix: /api/v1/inter-service
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="key",
+    api_prefix="/v2/api"  # Custom prefix
+)
+
+# Override per request
+response = client.request(
+    endpoint="custom",
+    api_prefix="/internal"
+)
+```
+
+## API Reference
+
+### InterServiceClient
+
+```python
+InterServiceClient(
+    base_url: str,
+    api_key: str,
+    api_prefix: str = "/api/v1/inter-service",
+    timeout: int = 30,
+    retry_attempts: int = 3,
+    ecc_private_key: str = None,
+    ecc_public_key: str = None
+)
+```
+
+#### Parameters
+
+- `base_url` (str): Base URL of the API (e.g., "https://api.example.com")
+- `api_key` (str): Bearer token for authentication
+- `api_prefix` (str, optional): API prefix. Default: "/api/v1/inter-service"
+- `timeout` (int, optional): Request timeout in seconds. Default: 30
+- `retry_attempts` (int, optional): Number of retry attempts. Default: 3
+- `ecc_private_key` (str, optional): ECC private key for decryption
+- `ecc_public_key` (str, optional): ECC public key for encryption
+
+### request()
+
+```python
+client.request(
+    endpoint: str,
+    path_params: dict = None,
+    query_params: dict = None,
+    method: str = "GET",
+    data: dict = None,
+    headers: dict = None,
+    encrypt: bool = False,
+    decrypt: bool = False,
+    timeout: int = None,
+    api_prefix: str = None
+) -> dict
+```
+
+#### Parameters
+
+- `endpoint` (str): Endpoint template (e.g., "users/{user_id}")
+- `path_params` (dict, optional): Path parameters for substitution
+- `query_params` (dict, optional): Query string parameters
+- `method` (str, optional): HTTP method. Default: "GET"
+- `data` (dict, optional): Request body (JSON)
+- `headers` (dict, optional): Additional headers
+- `encrypt` (bool, optional): Auto-encrypt request data. Default: False
+- `decrypt` (bool, optional): Auto-decrypt response. Default: False
+- `timeout` (int, optional): Override default timeout
+- `api_prefix` (str, optional): Override default API prefix
+
+#### Returns
+
+```python
+{
+    "status": "success" | "error",
+    "data": {...} | None,
+    "status_code": int,
+    "error": None | str
+}
+```
+
+## Error Handling
+
+```python
+response = client.request(endpoint="users/123")
+
+if response["status"] == "success":
+    user = response["data"]
+    print(user)
+else:
+    print(f"Error: {response['error']}")
+    print(f"Status code: {response['status_code']}")
+```
+
+## Configuration
+
+### Environment Variables
+
+```bash
+# Recommended approach
+export API_BASE_URL="https://api.example.com"
+export API_KEY="your-secret-key"
+export ECC_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----..."
+export ECC_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----..."
+```
+
+```python
+import os
+from inter_service_sdk import InterServiceClient
+
+client = InterServiceClient(
+    base_url=os.getenv("API_BASE_URL"),
+    api_key=os.getenv("API_KEY"),
+    ecc_private_key=os.getenv("ECC_PRIVATE_KEY"),
+    ecc_public_key=os.getenv("ECC_PUBLIC_KEY")
+)
+```
+
+## Development
+
+### Install Development Dependencies
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+### Run Tests
+
+```bash
+pytest tests/ -v
+```
+
+### Run Tests with Coverage
+
+```bash
+pytest tests/ --cov=inter_service_sdk --cov-report=html
+```
+
+### Code Formatting
+
+```bash
+black inter_service_sdk tests
+```
+
+### Type Checking
+
+```bash
+mypy inter_service_sdk
+```
+
+## Examples
+
+See the `examples/` directory for more usage examples:
+
+- `basic_usage.py` - Simple GET request
+- `with_encryption.py` - ECC encryption example
+- `search_example.py` - Query parameters example
+- `post_example.py` - POST request example
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Support
+
+For questions or issues, please open a GitHub issue.

inter_service_sdk-1.0.2/README.md

@@ -0,0 +1,283 @@
+# Inter-Service SDK
+
+Generic HTTP client for secure service-to-service communication with bearer token authentication and optional ECC encryption.
+
+## Features
+
+- 🔐 **Bearer Token Auth** - Automatic authentication headers
+- 🔒 **Optional ECC Encryption** - End-to-end encryption for sensitive data
+- 🎯 **Path & Query Parameters** - Clean parameter substitution
+- 🔄 **Automatic Retries** - Exponential backoff for failed requests
+- 📝 **Structured Logging** - Request/response tracking
+- 🚀 **Zero Dependencies** - Only requests and cryptography (optional)
+
+## Installation
+
+```bash
+pip install inter-service-sdk
+```
+
+## Quick Start
+
+```python
+from inter_service_sdk import InterServiceClient
+
+# Initialize client
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-secret-key"
+)
+
+# Make a request
+response = client.request(
+    endpoint="users/{user_id}",
+    path_params={"user_id": 123}
+)
+
+print(response["data"])
+```
+
+## Usage
+
+### Basic GET Request
+
+```python
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-api-key"
+)
+
+# GET /api/v1/inter-service/users/123
+user = client.request(
+    endpoint="users/{user_id}",
+    path_params={"user_id": 123}
+)
+```
+
+### With Query Parameters
+
+```python
+# GET /api/v1/inter-service/users/search?q=john&type=email&limit=10
+results = client.request(
+    endpoint="users/search",
+    query_params={
+        "q": "john",
+        "type": "email",
+        "limit": 10
+    }
+)
+```
+
+### POST Request
+
+```python
+# POST /api/v1/inter-service/users
+new_user = client.request(
+    endpoint="users",
+    method="POST",
+    data={
+        "name": "John Doe",
+        "email": "john@example.com"
+    }
+)
+```
+
+### With ECC Encryption
+
+```python
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="your-api-key",
+    ecc_private_key=os.getenv("PRIVATE_KEY"),
+    ecc_public_key=os.getenv("PUBLIC_KEY")
+)
+
+# Auto-decrypt response
+credentials = client.request(
+    endpoint="credentials/{id}",
+    path_params={"id": 456},
+    decrypt=True
+)
+
+# Auto-encrypt request
+client.request(
+    endpoint="secrets",
+    method="POST",
+    data={"secret": "sensitive data"},
+    encrypt=True
+)
+```
+
+### Custom API Prefix
+
+```python
+# Default prefix: /api/v1/inter-service
+client = InterServiceClient(
+    base_url="https://api.example.com",
+    api_key="key",
+    api_prefix="/v2/api"  # Custom prefix
+)
+
+# Override per request
+response = client.request(
+    endpoint="custom",
+    api_prefix="/internal"
+)
+```
+
+## API Reference
+
+### InterServiceClient
+
+```python
+InterServiceClient(
+    base_url: str,
+    api_key: str,
+    api_prefix: str = "/api/v1/inter-service",
+    timeout: int = 30,
+    retry_attempts: int = 3,
+    ecc_private_key: str = None,
+    ecc_public_key: str = None
+)
+```
+
+#### Parameters
+
+- `base_url` (str): Base URL of the API (e.g., "https://api.example.com")
+- `api_key` (str): Bearer token for authentication
+- `api_prefix` (str, optional): API prefix. Default: "/api/v1/inter-service"
+- `timeout` (int, optional): Request timeout in seconds. Default: 30
+- `retry_attempts` (int, optional): Number of retry attempts. Default: 3
+- `ecc_private_key` (str, optional): ECC private key for decryption
+- `ecc_public_key` (str, optional): ECC public key for encryption
+
+### request()
+
+```python
+client.request(
+    endpoint: str,
+    path_params: dict = None,
+    query_params: dict = None,
+    method: str = "GET",
+    data: dict = None,
+    headers: dict = None,
+    encrypt: bool = False,
+    decrypt: bool = False,
+    timeout: int = None,
+    api_prefix: str = None
+) -> dict
+```
+
+#### Parameters
+
+- `endpoint` (str): Endpoint template (e.g., "users/{user_id}")
+- `path_params` (dict, optional): Path parameters for substitution
+- `query_params` (dict, optional): Query string parameters
+- `method` (str, optional): HTTP method. Default: "GET"
+- `data` (dict, optional): Request body (JSON)
+- `headers` (dict, optional): Additional headers
+- `encrypt` (bool, optional): Auto-encrypt request data. Default: False
+- `decrypt` (bool, optional): Auto-decrypt response. Default: False
+- `timeout` (int, optional): Override default timeout
+- `api_prefix` (str, optional): Override default API prefix
+
+#### Returns
+
+```python
+{
+    "status": "success" | "error",
+    "data": {...} | None,
+    "status_code": int,
+    "error": None | str
+}
+```
+
+## Error Handling
+
+```python
+response = client.request(endpoint="users/123")
+
+if response["status"] == "success":
+    user = response["data"]
+    print(user)
+else:
+    print(f"Error: {response['error']}")
+    print(f"Status code: {response['status_code']}")
+```
+
+## Configuration
+
+### Environment Variables
+
+```bash
+# Recommended approach
+export API_BASE_URL="https://api.example.com"
+export API_KEY="your-secret-key"
+export ECC_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----..."
+export ECC_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----..."
+```
+
+```python
+import os
+from inter_service_sdk import InterServiceClient
+
+client = InterServiceClient(
+    base_url=os.getenv("API_BASE_URL"),
+    api_key=os.getenv("API_KEY"),
+    ecc_private_key=os.getenv("ECC_PRIVATE_KEY"),
+    ecc_public_key=os.getenv("ECC_PUBLIC_KEY")
+)
+```
+
+## Development
+
+### Install Development Dependencies
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+### Run Tests
+
+```bash
+pytest tests/ -v
+```
+
+### Run Tests with Coverage
+
+```bash
+pytest tests/ --cov=inter_service_sdk --cov-report=html
+```
+
+### Code Formatting
+
+```bash
+black inter_service_sdk tests
+```
+
+### Type Checking
+
+```bash
+mypy inter_service_sdk
+```
+
+## Examples
+
+See the `examples/` directory for more usage examples:
+
+- `basic_usage.py` - Simple GET request
+- `with_encryption.py` - ECC encryption example
+- `search_example.py` - Query parameters example
+- `post_example.py` - POST request example
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+## Support
+
+For questions or issues, please open a GitHub issue.

inter_service_sdk-1.0.2/inter_service_sdk/__init__.py

@@ -0,0 +1,42 @@
+"""
+Inter-Service SDK - Complete framework for service-to-service communication.
+
+Provides both client-side and server-side utilities:
+- Client: InterServiceClient for making inter-service HTTP requests
+- Server: FastAPI utilities for creating inter-service endpoints
+- Crypto: Optional ECC encryption/decryption
+- Exceptions: Custom exception hierarchy
+"""
+
+from .client import InterServiceClient
+from .exceptions import (
+    InterServiceError,
+    AuthenticationError,
+    RequestError,
+    EncryptionError,
+    URLBuildError
+)
+from .server import (
+    create_inter_service_router,
+    inter_service_endpoint,
+    format_error_response,
+    format_success_response
+)
+
+__version__ = "1.0.2"
+
+__all__ = [
+    # Client
+    "InterServiceClient",
+    # Exceptions
+    "InterServiceError",
+    "AuthenticationError",
+    "RequestError",
+    "EncryptionError",
+    "URLBuildError",
+    # Server utilities
+    "create_inter_service_router",
+    "inter_service_endpoint",
+    "format_error_response",
+    "format_success_response",
+]