embed-client 2.0.0.0__tar.gz → 3.1.0.1__tar.gz

embed_client-3.1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vasiliy Zdanovskiy
+
+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.

embed_client-3.1.0.1/MANIFEST.in

@@ -0,0 +1,15 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include examples *.py *.md *.json
+recursive-include docs *.md
+recursive-include configs *.json
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .pytest_cache
+recursive-exclude * .git*
+recursive-exclude * .venv
+recursive-exclude * tests
+recursive-exclude * mtls_certificates
+recursive-exclude * logs
+recursive-exclude * test_environment

embed_client-3.1.0.1/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: embed-client
+Version: 3.1.0.1
+Summary: Async client for Embedding Service API with comprehensive authentication, SSL/TLS, and mTLS support
+Author-email: Vasiliy Zdanovskiy <vasilyvz@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/vasilyvz/embed-client
+Project-URL: Repository, https://github.com/vasilyvz/embed-client
+Project-URL: Documentation, https://github.com/vasilyvz/embed-client#readme
+Project-URL: Bug Tracker, https://github.com/vasilyvz/embed-client/issues
+Keywords: embedding,async,client,api,authentication,ssl,tls,mtls
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+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 :: HTTP Servers
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: PyJWT>=2.0.0
+Requires-Dist: cryptography>=3.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Dynamic: license-file
+
+# embed-client
+
+Асинхронный клиент для Embedding Service API с поддержкой всех режимов безопасности.
+
+## Возможности
+
+- ✅ **Асинхронный API** - полная поддержка async/await
+- ✅ **Все режимы безопасности** - HTTP, HTTPS, mTLS
+- ✅ **Аутентификация** - API Key, JWT, Basic Auth, Certificate
+- ✅ **SSL/TLS поддержка** - полная интеграция с mcp_security_framework
+- ✅ **Конфигурация** - файлы конфигурации, переменные окружения, аргументы
+- ✅ **Обратная совместимость** - API формат не изменился, добавлена только безопасность
+- ✅ **Типизация** - 100% type-annotated код
+- ✅ **Тестирование** - 84+ тестов с полным покрытием
+
+## Quick Start: Примеры запуска
+
+### Базовое использование
+
+**Вариант 1: через аргументы командной строки**
+
+```sh
+# HTTP без аутентификации
+python embed_client/example_async_usage.py --base-url http://localhost --port 8001
+
+# HTTP с API ключом
+python embed_client/example_async_usage.py --base-url http://localhost --port 8001 \
+  --auth-method api_key --api-key admin_key_123
+
+# HTTPS с SSL
+python embed_client/example_async_usage.py --base-url https://localhost --port 9443 \
+  --ssl-verify-mode CERT_REQUIRED
+
+# mTLS с сертификатами
+python embed_client/example_async_usage.py --base-url https://localhost --port 9443 \
+  --cert-file certs/client.crt --key-file keys/client.key --ca-cert-file certs/ca.crt
+```
+
+**Вариант 2: через переменные окружения**
+
+```sh
+export EMBED_CLIENT_BASE_URL=http://localhost
+export EMBED_CLIENT_PORT=8001
+export EMBED_CLIENT_AUTH_METHOD=api_key
+export EMBED_CLIENT_API_KEY=admin_key_123
+python embed_client/example_async_usage.py
+```
+
+**Вариант 3: через файл конфигурации**
+
+```sh
+python embed_client/example_async_usage.py --config configs/https_token.json
+```
+
+### Режимы безопасности
+
+#### 1. HTTP (без аутентификации)
+```python
+from embed_client.async_client import EmbeddingServiceAsyncClient
+
+client = EmbeddingServiceAsyncClient(
+    base_url="http://localhost",
+    port=8001
+)
+```
+
+#### 2. HTTP + Token
+```python
+from embed_client.config import ClientConfig
+
+# API Key
+config = ClientConfig.create_http_token_config(
+    "http://localhost", 8001, {"user": "api_key_123"}
+)
+
+# JWT
+config = ClientConfig.create_http_jwt_config(
+    "http://localhost", 8001, "secret", "username", "password"
+)
+
+# Basic Auth
+config = ClientConfig.create_http_basic_config(
+    "http://localhost", 8001, "username", "password"
+)
+```
+
+#### 3. HTTPS
+```python
+config = ClientConfig.create_https_config(
+    "https://localhost", 9443,
+    ca_cert_file="certs/ca.crt"
+)
+```
+
+#### 4. mTLS (взаимная аутентификация)
+```python
+config = ClientConfig.create_mtls_config(
+    "https://localhost", 9443,
+    cert_file="certs/client.crt",
+    key_file="keys/client.key",
+    ca_cert_file="certs/ca.crt"
+)
+```
+
+### Программное использование
+
+```python
+import asyncio
+from embed_client.async_client import EmbeddingServiceAsyncClient
+from embed_client.config import ClientConfig
+
+async def main():
+    # Создание конфигурации
+    config = ClientConfig.create_http_token_config(
+        "http://localhost", 8001, {"user": "api_key_123"}
+    )
+    
+    # Использование клиента
+    async with EmbeddingServiceAsyncClient.from_config(config) as client:
+        # Проверка статуса
+        print(f"Аутентификация: {client.get_auth_method()}")
+        print(f"SSL включен: {client.is_ssl_enabled()}")
+        print(f"mTLS включен: {client.is_mtls_enabled()}")
+        
+        # Выполнение запроса
+        result = await client.cmd("embed", params={"texts": ["hello world"]})
+        
+        # Извлечение данных
+        embeddings = client.extract_embeddings(result)
+        texts = client.extract_texts(result)
+        tokens = client.extract_tokens(result)
+        bm25_tokens = client.extract_bm25_tokens(result)
+        
+        print(f"Эмбеддинги: {embeddings}")
+        print(f"Тексты: {texts}")
+        print(f"Токены: {tokens}")
+        print(f"BM25 токены: {bm25_tokens}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Установка
+
+```bash
+# Установка из PyPI
+pip install embed-client
+
+# Установка в режиме разработки
+git clone <repository>
+cd embed-client
+pip install -e .
+```
+
+## Зависимости
+
+- `aiohttp` - асинхронные HTTP запросы
+- `PyJWT>=2.0.0` - JWT токены
+- `cryptography>=3.0.0` - криптография и сертификаты
+- `pydantic>=2.0.0` - валидация конфигурации
+
+## Тестирование
+
+```bash
+# Запуск всех тестов
+pytest tests/
+
+# Запуск тестов с покрытием
+pytest tests/ --cov=embed_client
+
+# Запуск конкретных тестов
+pytest tests/test_async_client.py -v
+pytest tests/test_config.py -v
+pytest tests/test_auth.py -v
+pytest tests/test_ssl_manager.py -v
+```
+
+## Документация
+
+- [Формат API и режимы безопасности](docs/api_format.md)
+- [Примеры использования](embed_client/example_async_usage.py)
+- [Примеры на русском](embed_client/example_async_usage_ru.py)
+
+## Безопасность
+
+### Рекомендации
+
+1. **Используйте HTTPS** для продакшена
+2. **Включите проверку сертификатов** (CERT_REQUIRED)
+3. **Используйте mTLS** для критически важных систем
+4. **Регулярно обновляйте сертификаты**
+5. **Храните приватные ключи в безопасном месте**
+
+### Поддерживаемые протоколы
+
+- TLS 1.2
+- TLS 1.3
+- SSL 3.0 (устаревший, не рекомендуется)
+
+## Лицензия
+
+MIT License
+
+## Автор
+
+**Vasiliy Zdanovskiy**  
+Email: vasilyvz@gmail.com
+
+---
+
+**Важно:**
+- Используйте `--base-url` (через дефис), а не `--base_url` (через подчеркивание).
+- Значение base_url должно содержать `http://` или `https://`.
+- Аргументы должны быть отдельными (через пробел), а не через `=`.

embed_client-3.1.0.1/README.md

@@ -0,0 +1,214 @@
+# embed-client
+
+Асинхронный клиент для Embedding Service API с поддержкой всех режимов безопасности.
+
+## Возможности
+
+- ✅ **Асинхронный API** - полная поддержка async/await
+- ✅ **Все режимы безопасности** - HTTP, HTTPS, mTLS
+- ✅ **Аутентификация** - API Key, JWT, Basic Auth, Certificate
+- ✅ **SSL/TLS поддержка** - полная интеграция с mcp_security_framework
+- ✅ **Конфигурация** - файлы конфигурации, переменные окружения, аргументы
+- ✅ **Обратная совместимость** - API формат не изменился, добавлена только безопасность
+- ✅ **Типизация** - 100% type-annotated код
+- ✅ **Тестирование** - 84+ тестов с полным покрытием
+
+## Quick Start: Примеры запуска
+
+### Базовое использование
+
+**Вариант 1: через аргументы командной строки**
+
+```sh
+# HTTP без аутентификации
+python embed_client/example_async_usage.py --base-url http://localhost --port 8001
+
+# HTTP с API ключом
+python embed_client/example_async_usage.py --base-url http://localhost --port 8001 \
+  --auth-method api_key --api-key admin_key_123
+
+# HTTPS с SSL
+python embed_client/example_async_usage.py --base-url https://localhost --port 9443 \
+  --ssl-verify-mode CERT_REQUIRED
+
+# mTLS с сертификатами
+python embed_client/example_async_usage.py --base-url https://localhost --port 9443 \
+  --cert-file certs/client.crt --key-file keys/client.key --ca-cert-file certs/ca.crt
+```
+
+**Вариант 2: через переменные окружения**
+
+```sh
+export EMBED_CLIENT_BASE_URL=http://localhost
+export EMBED_CLIENT_PORT=8001
+export EMBED_CLIENT_AUTH_METHOD=api_key
+export EMBED_CLIENT_API_KEY=admin_key_123
+python embed_client/example_async_usage.py
+```
+
+**Вариант 3: через файл конфигурации**
+
+```sh
+python embed_client/example_async_usage.py --config configs/https_token.json
+```
+
+### Режимы безопасности
+
+#### 1. HTTP (без аутентификации)
+```python
+from embed_client.async_client import EmbeddingServiceAsyncClient
+
+client = EmbeddingServiceAsyncClient(
+    base_url="http://localhost",
+    port=8001
+)
+```
+
+#### 2. HTTP + Token
+```python
+from embed_client.config import ClientConfig
+
+# API Key
+config = ClientConfig.create_http_token_config(
+    "http://localhost", 8001, {"user": "api_key_123"}
+)
+
+# JWT
+config = ClientConfig.create_http_jwt_config(
+    "http://localhost", 8001, "secret", "username", "password"
+)
+
+# Basic Auth
+config = ClientConfig.create_http_basic_config(
+    "http://localhost", 8001, "username", "password"
+)
+```
+
+#### 3. HTTPS
+```python
+config = ClientConfig.create_https_config(
+    "https://localhost", 9443,
+    ca_cert_file="certs/ca.crt"
+)
+```
+
+#### 4. mTLS (взаимная аутентификация)
+```python
+config = ClientConfig.create_mtls_config(
+    "https://localhost", 9443,
+    cert_file="certs/client.crt",
+    key_file="keys/client.key",
+    ca_cert_file="certs/ca.crt"
+)
+```
+
+### Программное использование
+
+```python
+import asyncio
+from embed_client.async_client import EmbeddingServiceAsyncClient
+from embed_client.config import ClientConfig
+
+async def main():
+    # Создание конфигурации
+    config = ClientConfig.create_http_token_config(
+        "http://localhost", 8001, {"user": "api_key_123"}
+    )
+    
+    # Использование клиента
+    async with EmbeddingServiceAsyncClient.from_config(config) as client:
+        # Проверка статуса
+        print(f"Аутентификация: {client.get_auth_method()}")
+        print(f"SSL включен: {client.is_ssl_enabled()}")
+        print(f"mTLS включен: {client.is_mtls_enabled()}")
+        
+        # Выполнение запроса
+        result = await client.cmd("embed", params={"texts": ["hello world"]})
+        
+        # Извлечение данных
+        embeddings = client.extract_embeddings(result)
+        texts = client.extract_texts(result)
+        tokens = client.extract_tokens(result)
+        bm25_tokens = client.extract_bm25_tokens(result)
+        
+        print(f"Эмбеддинги: {embeddings}")
+        print(f"Тексты: {texts}")
+        print(f"Токены: {tokens}")
+        print(f"BM25 токены: {bm25_tokens}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Установка
+
+```bash
+# Установка из PyPI
+pip install embed-client
+
+# Установка в режиме разработки
+git clone <repository>
+cd embed-client
+pip install -e .
+```
+
+## Зависимости
+
+- `aiohttp` - асинхронные HTTP запросы
+- `PyJWT>=2.0.0` - JWT токены
+- `cryptography>=3.0.0` - криптография и сертификаты
+- `pydantic>=2.0.0` - валидация конфигурации
+
+## Тестирование
+
+```bash
+# Запуск всех тестов
+pytest tests/
+
+# Запуск тестов с покрытием
+pytest tests/ --cov=embed_client
+
+# Запуск конкретных тестов
+pytest tests/test_async_client.py -v
+pytest tests/test_config.py -v
+pytest tests/test_auth.py -v
+pytest tests/test_ssl_manager.py -v
+```
+
+## Документация
+
+- [Формат API и режимы безопасности](docs/api_format.md)
+- [Примеры использования](embed_client/example_async_usage.py)
+- [Примеры на русском](embed_client/example_async_usage_ru.py)
+
+## Безопасность
+
+### Рекомендации
+
+1. **Используйте HTTPS** для продакшена
+2. **Включите проверку сертификатов** (CERT_REQUIRED)
+3. **Используйте mTLS** для критически важных систем
+4. **Регулярно обновляйте сертификаты**
+5. **Храните приватные ключи в безопасном месте**
+
+### Поддерживаемые протоколы
+
+- TLS 1.2
+- TLS 1.3
+- SSL 3.0 (устаревший, не рекомендуется)
+
+## Лицензия
+
+MIT License
+
+## Автор
+
+**Vasiliy Zdanovskiy**  
+Email: vasilyvz@gmail.com
+
+---
+
+**Важно:**
+- Используйте `--base-url` (через дефис), а не `--base_url` (через подчеркивание).
+- Значение base_url должно содержать `http://` или `https://`.
+- Аргументы должны быть отдельными (через пробел), а не через `=`.

embed_client-3.1.0.1/configs/basic_auth.json

@@ -0,0 +1,52 @@
+{
+  "server": {
+    "host": "localhost",
+    "port": 8001,
+    "base_url": "http://localhost:8001"
+  },
+  "timeout": 30,
+  "retry_attempts": 3,
+  "retry_delay": 1,
+  "auth": {
+    "method": "basic",
+    "api_key": {
+      "key": null,
+      "header": "X-API-Key"
+    },
+    "jwt": {
+      "username": null,
+      "password": null,
+      "secret": null,
+      "expiry_hours": 24
+    },
+    "certificate": {
+      "enabled": false,
+      "cert_file": null,
+      "key_file": null,
+      "ca_cert_file": null
+    },
+    "basic": {
+      "username": "user",
+      "password": "password"
+    }
+  },
+  "ssl": {
+    "enabled": false,
+    "verify": true,
+    "check_hostname": true,
+    "cert_file": null,
+    "key_file": null,
+    "ca_cert_file": null,
+    "client_cert_required": false
+  },
+  "security": {
+    "enabled": false,
+    "roles_enabled": false,
+    "roles_file": null
+  },
+  "logging": {
+    "enabled": false,
+    "level": "INFO",
+    "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+  }
+}

embed_client-3.1.0.1/configs/http.json

@@ -0,0 +1,38 @@
+{
+  "uuid": "42597aa6-679e-4e63-8de4-31206ad5b1e6",
+  "server": {
+    "host": "0.0.0.0",
+    "port": 20000,
+    "protocol": "http",
+    "debug": false,
+    "log_level": "INFO"
+  },
+  "logging": {
+    "level": "INFO",
+    "file": null,
+    "log_dir": "./logs",
+    "log_file": "mcp_proxy_adapter.log",
+    "max_size": 10,
+    "backup_count": 5,
+    "console_output": true,
+    "json_format": false
+  },
+  "security": {
+    "enabled": false,
+    "tokens": {},
+    "roles": {},
+    "roles_file": null
+  },
+  "debug": {
+    "enabled": false,
+    "log_level": "DEBUG",
+    "trace_requests": false,
+    "trace_responses": false
+  },
+  "transport": {
+    "type": "http",
+    "port": null,
+    "verify_client": false,
+    "chk_hostname": false
+  }
+}

embed_client-3.1.0.1/configs/http_correct.json

@@ -0,0 +1,12 @@
+{
+  "server": {
+    "host": "http://localhost",
+    "port": 8001
+  },
+  "auth": {
+    "method": "none"
+  },
+  "ssl": {
+    "enabled": false
+  }
+}

embed_client-3.1.0.1/configs/http_simple.json

@@ -0,0 +1,52 @@
+{
+  "server": {
+    "host": "localhost",
+    "port": 8001,
+    "base_url": "http://localhost:8001"
+  },
+  "timeout": 30,
+  "retry_attempts": 3,
+  "retry_delay": 1,
+  "auth": {
+    "method": "none",
+    "api_key": {
+      "key": null,
+      "header": "X-API-Key"
+    },
+    "jwt": {
+      "username": null,
+      "password": null,
+      "secret": null,
+      "expiry_hours": 24
+    },
+    "certificate": {
+      "enabled": false,
+      "cert_file": null,
+      "key_file": null,
+      "ca_cert_file": null
+    },
+    "basic": {
+      "username": null,
+      "password": null
+    }
+  },
+  "ssl": {
+    "enabled": false,
+    "verify": true,
+    "check_hostname": true,
+    "cert_file": null,
+    "key_file": null,
+    "ca_cert_file": null,
+    "client_cert_required": false
+  },
+  "security": {
+    "enabled": false,
+    "roles_enabled": false,
+    "roles_file": null
+  },
+  "logging": {
+    "enabled": false,
+    "level": "INFO",
+    "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+  }
+}

embed_client-3.1.0.1/configs/http_test.json

@@ -0,0 +1,12 @@
+{
+  "server": {
+    "host": "http://localhost",
+    "port": 8001
+  },
+  "auth": {
+    "method": "none"
+  },
+  "ssl": {
+    "enabled": false
+  }
+}