assistagro-client 0.3.1__tar.gz

assistagro_client-0.3.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: assistagro-client
+Version: 0.3.1
+Summary: HTTP client for AssistAgro API
+Author-email: Dmitriy Kazakov <dmitriyfile@yandex.ru>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: python-dotenv>=1.0.0
+
+# AssistAgro API Client
+
+Синхронный и асинхронный HTTP-клиент для AssistAgro API.
+
+## Установка
+
+```bash
+pip install assistagro-client
+```
+
+## Асинхронное использование
+
+```python
+import asyncio
+from assistagro_client import AssistAgroClient
+
+async def main():
+    async with AssistAgroClient(base_url="https://gateway-frontend.agroassist.ru") as client:
+        tokens = await client.auth.sign_in(
+            email="user@example.com",
+            password="password123"
+        )
+        print(f"Access token: {tokens.access_token[:20]}...")
+
+        structures = await client.structures.list_()
+        structure_guid = structures[0].structure_guid
+
+        season = await client.seasons.get_current()
+
+        fields = await client.fields.list_(
+            structure_guids=[structure_guid],
+            season_id=season.season_id,
+        )
+        print(f"Найдено полей: {len(fields)}")
+
+        crops_response = await client.dictionaries.get_crops()
+        print(f"Культур: {len(crops_response.crops)}")
+
+        tasks = await client.tasks.list_(structure_guid=structure_guid)
+        print(f"Найдено задач: {len(tasks)}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Синхронное использование
+
+```python
+from assistagro_client import AssistAgroSyncClient
+
+with AssistAgroSyncClient(base_url="https://gateway-frontend.agroassist.ru") as client:
+    tokens = client.auth.sign_in(
+        email="user@example.com",
+        password="password123",
+    )
+    print(f"Access token: {tokens.access_token[:20]}...")
+
+    structures = client.structures.list_()
+    print(f"Найдено структур: {len(structures)}")
+```
+
+`AssistAgroClient` остается асинхронным клиентом для обратной совместимости.
+`AssistAgroSyncClient` предоставляет тот же набор API-разделов для обычного синхронного кода.
+Если нужно передать контекст пользователя в `x-user-data`, используйте `set_user_data(...)`;
+заголовок сериализуется как компактный JSON, например
+`{"company_guid":"...","user_guid":"..."}`.
+
+## TLS/SSL сертификаты
+
+По умолчанию клиент проверяет TLS-сертификат сервера. Если окружение использует свой
+CA-bundle, передайте путь к нему:
+
+```python
+client = AssistAgroClient(verify="/path/to/ca-bundle.pem")
+```
+
+Если сервер временно отдает некорректную цепочку сертификатов, проверку можно отключить
+явно:
+
+```python
+client = AssistAgroClient(verify=False)
+```
+
+То же доступно для `AssistAgroSyncClient` и через переменную окружения
+`ASSISTAGRO_VERIFY_SSL=false`.
+
+## API эндпоинты
+
+| Модуль | Описание | Основные методы |
+|--------|----------|-----------------|
+| **auth** | Аутентификация | `sign_in`, `refresh_tokens`, `logout` |
+| **accounts** | Пользователи | `get_current_user`, `get_users` |
+| **companies** | Компании | `list_()`, `list_all`, `get`, `get_license`, `get_license_metadata`, `get_activities`, `get_dashboards` |
+| **structures** | Структуры | `list_()`, `list_plain` |
+| **seasons** | Сезоны | `list`, `get_current`, `get_by_name`, `get_season_id_by_name` |
+| **fields** | Поля | `list_()`, `get_contours`, `get_phenophases`, `get_monitoring`, `list_meta` |
+| **tasks** | Задачи | `list_()`, `create`, `get_list_meta` |
+| **reports** | Отчёты | `list_()`, `create`, `get_metadata`, `get_problems`, `get_list_meta` |
+| **techmaps** | Технологические карты | `list_()`, `create` |
+| **meteostations** | Метеостанции | `list_()`, `get`, `get_by_field`, `get_manufacturers`, `get_providers`, `get_sensors`, `get_coordinates_history`, `get_history` |
+| **dictionaries** | Справочники | `get_crops`, `get_crop_products`, `get_techoperations`, `get_pesticides`, `get_fertilizers`, `get_machines`, `get_tools`, `get_units`, `get_regions`, `get_countries`, и др. |
+
+## Примеры
+
+Скопируйте `.env.example` в `.env` и заполните переменные:
+
+```bash
+cp .env.example .env
+```
+
+```env
+ASSISTAGRO_EMAIL=user@example.com
+ASSISTAGRO_PASSWORD=your-password
+ASSISTAGRO_BASE_URL=https://gateway-frontend.agroassist.ru
+ASSISTAGRO_DEBUG=false
+```
+
+Запуск примеров:
+
+```bash
+# Запустить все модули
+uv run python examples/run_tests.py
+
+# Запустить конкретный модуль
+uv run python examples/run_tests.py --module structures
+uv run python examples/run_tests.py -m auth
+
+# Доступные модули:
+# auth, structures, companies, current_user, users,
+# dictionaries, meteostations, tasks, fields, reports, techmaps, seasons
+```
+
+## Разработка
+
+```bash
+# Установить зависимости
+uv sync
+
+# Запустить тесты
+uv run pytest
+
+# Запустить линтер
+uv run ruff check .
+uv run ruff check --fix .
+
+# Проверка типов
+uv run mypy src/
+
+# Форматирование
+uv run black .
+```
+
+## Лицензия
+
+MIT

assistagro_client-0.3.1/README.md

@@ -0,0 +1,155 @@
+# AssistAgro API Client
+
+Синхронный и асинхронный HTTP-клиент для AssistAgro API.
+
+## Установка
+
+```bash
+pip install assistagro-client
+```
+
+## Асинхронное использование
+
+```python
+import asyncio
+from assistagro_client import AssistAgroClient
+
+async def main():
+    async with AssistAgroClient(base_url="https://gateway-frontend.agroassist.ru") as client:
+        tokens = await client.auth.sign_in(
+            email="user@example.com",
+            password="password123"
+        )
+        print(f"Access token: {tokens.access_token[:20]}...")
+
+        structures = await client.structures.list_()
+        structure_guid = structures[0].structure_guid
+
+        season = await client.seasons.get_current()
+
+        fields = await client.fields.list_(
+            structure_guids=[structure_guid],
+            season_id=season.season_id,
+        )
+        print(f"Найдено полей: {len(fields)}")
+
+        crops_response = await client.dictionaries.get_crops()
+        print(f"Культур: {len(crops_response.crops)}")
+
+        tasks = await client.tasks.list_(structure_guid=structure_guid)
+        print(f"Найдено задач: {len(tasks)}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Синхронное использование
+
+```python
+from assistagro_client import AssistAgroSyncClient
+
+with AssistAgroSyncClient(base_url="https://gateway-frontend.agroassist.ru") as client:
+    tokens = client.auth.sign_in(
+        email="user@example.com",
+        password="password123",
+    )
+    print(f"Access token: {tokens.access_token[:20]}...")
+
+    structures = client.structures.list_()
+    print(f"Найдено структур: {len(structures)}")
+```
+
+`AssistAgroClient` остается асинхронным клиентом для обратной совместимости.
+`AssistAgroSyncClient` предоставляет тот же набор API-разделов для обычного синхронного кода.
+Если нужно передать контекст пользователя в `x-user-data`, используйте `set_user_data(...)`;
+заголовок сериализуется как компактный JSON, например
+`{"company_guid":"...","user_guid":"..."}`.
+
+## TLS/SSL сертификаты
+
+По умолчанию клиент проверяет TLS-сертификат сервера. Если окружение использует свой
+CA-bundle, передайте путь к нему:
+
+```python
+client = AssistAgroClient(verify="/path/to/ca-bundle.pem")
+```
+
+Если сервер временно отдает некорректную цепочку сертификатов, проверку можно отключить
+явно:
+
+```python
+client = AssistAgroClient(verify=False)
+```
+
+То же доступно для `AssistAgroSyncClient` и через переменную окружения
+`ASSISTAGRO_VERIFY_SSL=false`.
+
+## API эндпоинты
+
+| Модуль | Описание | Основные методы |
+|--------|----------|-----------------|
+| **auth** | Аутентификация | `sign_in`, `refresh_tokens`, `logout` |
+| **accounts** | Пользователи | `get_current_user`, `get_users` |
+| **companies** | Компании | `list_()`, `list_all`, `get`, `get_license`, `get_license_metadata`, `get_activities`, `get_dashboards` |
+| **structures** | Структуры | `list_()`, `list_plain` |
+| **seasons** | Сезоны | `list`, `get_current`, `get_by_name`, `get_season_id_by_name` |
+| **fields** | Поля | `list_()`, `get_contours`, `get_phenophases`, `get_monitoring`, `list_meta` |
+| **tasks** | Задачи | `list_()`, `create`, `get_list_meta` |
+| **reports** | Отчёты | `list_()`, `create`, `get_metadata`, `get_problems`, `get_list_meta` |
+| **techmaps** | Технологические карты | `list_()`, `create` |
+| **meteostations** | Метеостанции | `list_()`, `get`, `get_by_field`, `get_manufacturers`, `get_providers`, `get_sensors`, `get_coordinates_history`, `get_history` |
+| **dictionaries** | Справочники | `get_crops`, `get_crop_products`, `get_techoperations`, `get_pesticides`, `get_fertilizers`, `get_machines`, `get_tools`, `get_units`, `get_regions`, `get_countries`, и др. |
+
+## Примеры
+
+Скопируйте `.env.example` в `.env` и заполните переменные:
+
+```bash
+cp .env.example .env
+```
+
+```env
+ASSISTAGRO_EMAIL=user@example.com
+ASSISTAGRO_PASSWORD=your-password
+ASSISTAGRO_BASE_URL=https://gateway-frontend.agroassist.ru
+ASSISTAGRO_DEBUG=false
+```
+
+Запуск примеров:
+
+```bash
+# Запустить все модули
+uv run python examples/run_tests.py
+
+# Запустить конкретный модуль
+uv run python examples/run_tests.py --module structures
+uv run python examples/run_tests.py -m auth
+
+# Доступные модули:
+# auth, structures, companies, current_user, users,
+# dictionaries, meteostations, tasks, fields, reports, techmaps, seasons
+```
+
+## Разработка
+
+```bash
+# Установить зависимости
+uv sync
+
+# Запустить тесты
+uv run pytest
+
+# Запустить линтер
+uv run ruff check .
+uv run ruff check --fix .
+
+# Проверка типов
+uv run mypy src/
+
+# Форматирование
+uv run black .
+```
+
+## Лицензия
+
+MIT

assistagro_client-0.3.1/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "assistagro-client"
+version = "0.3.1"
+description = "HTTP client for AssistAgro API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    {name = "Dmitriy Kazakov", email = "dmitriyfile@yandex.ru"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.12.5",
+    "pydantic-settings>=2.13.1",
+    "python-dateutil>=2.9.0.post0",
+    "python-dotenv>=1.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "ruff>=0.9.0",
+    "mypy>=1.15.0",
+]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

assistagro_client-0.3.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

assistagro_client-0.3.1/src/assistagro_client/__init__.py

@@ -0,0 +1,20 @@
+"""AssistAgro API Client."""
+
+from .client import AssistAgroClient, AssistAgroSyncClient
+from .auth import Auth, AuthTokens, SignInRequest, OTPResponse
+from .exceptions import AssistAgroError, AuthenticationError, APIError, TimeoutError
+from .api.v1.seasons import Season
+
+__all__ = [
+    "AssistAgroClient",
+    "AssistAgroSyncClient",
+    "Auth",
+    "AuthTokens",
+    "SignInRequest",
+    "OTPResponse",
+    "AssistAgroError",
+    "AuthenticationError",
+    "APIError",
+    "TimeoutError",
+    "Season",
+]

assistagro_client-0.3.1/src/assistagro_client/api/__init__.py

@@ -0,0 +1 @@
+"""API v1 endpoints."""

assistagro_client-0.3.1/src/assistagro_client/api/v1/__init__.py

@@ -0,0 +1 @@
+"""API v1 endpoints."""

assistagro_client-0.3.1/src/assistagro_client/api/v1/accounts.py

@@ -0,0 +1,42 @@
+"""Accounts API endpoints."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+from uuid import UUID
+
+from assistagro_client.models.accounts import UserProfile
+
+if TYPE_CHECKING:
+    from assistagro_client.client import AssistAgroClient
+
+
+class AccountsAPI:
+    """Accounts API endpoints."""
+
+    def __init__(self, client: AssistAgroClient):
+        self._client = client
+
+    async def get_users(self, account_guid: UUID | None = None) -> list[UserProfile]:
+        """Get user profiles."""
+        params = {}
+        if account_guid:
+            params["account_guid"] = str(account_guid)
+        response = await self._client.get("/account/users", params=params)
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return [UserProfile(**item) for item in data] if data else []
+
+    async def get_current_user(self) -> dict:
+        """Get current user info."""
+        response = await self._client.get("/account/users/current")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return data if data else {}
+
+    async def get_user(self, user_guid: UUID) -> dict:
+        """Get user by GUID."""
+        response = await self._client.get(f"/account/users/{user_guid}")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return data if data else {}

assistagro_client-0.3.1/src/assistagro_client/api/v1/companies.py

@@ -0,0 +1,108 @@
+"""Companies API endpoints."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Optional
+from uuid import UUID
+
+from assistagro_client.models.companies import Company, CompanyLicense
+
+if TYPE_CHECKING:
+    from assistagro_client.client import AssistAgroClient
+
+
+class CompaniesAPI:
+    """Companies API endpoints."""
+
+    def __init__(self, client: AssistAgroClient):
+        self._client = client
+
+    async def list_(self) -> list[Company]:
+        """Get current user's company.
+
+        Returns the company associated with the authenticated user.
+        """
+        response = await self._client.get("/account/users/current")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        if isinstance(data, dict) and "company" in data:
+            company_data = data["company"]
+            return [Company(**company_data)] if company_data else []
+        return []
+
+    async def list_all(self) -> list[dict[str, Any]]:
+        """Get all companies (requires superadmin permission 1).
+
+        Returns:
+            List of company objects with guid, name, user_count, active_flag, license.
+        """
+        response = await self._client.get("/companies")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return data if isinstance(data, list) else []
+
+    async def get(self, company_guid: UUID) -> dict[str, Any]:
+        """Get company by GUID.
+
+        Args:
+            company_guid: Company GUID.
+
+        Returns:
+            Company data with guid, name, user_count, active_flag.
+        """
+        response = await self._client.get(f"/companies/{company_guid}")
+        response.raise_for_status()
+        return self._client._parse_json_response(response)
+
+    async def get_license(
+        self, company_guid: Optional[UUID] = None
+    ) -> CompanyLicense:
+        """Get company license info.
+
+        Args:
+            company_guid: Optional company GUID. If not provided, uses token's company.
+
+        Returns:
+            Company license information.
+        """
+        params: dict[str, Any] = {}
+        if company_guid:
+            params["company_guid"] = str(company_guid)
+        response = await self._client.get("/companies/license", params=params)
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return CompanyLicense(**data)
+
+    async def get_license_metadata(self) -> dict[str, Any]:
+        """Get license metadata (modules, permissions, license types, limits).
+
+        Returns:
+            Dict with modules, permissions, permission_groups, license_types, license_limits.
+        """
+        response = await self._client.get("/companies/license/metadata")
+        response.raise_for_status()
+        return self._client._parse_json_response(response)
+
+    async def get_activities(self) -> list[dict[str, Any]]:
+        """Get company activity types.
+
+        Returns:
+            List of company activities with id and description.
+        """
+        response = await self._client.get("/companies/activities")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        if isinstance(data, dict) and "company_activities" in data:
+            return data["company_activities"]
+        return []
+
+    async def get_dashboards(self) -> list[dict[str, Any]]:
+        """Get company dashboards (requires permission 55).
+
+        Returns:
+            List of dashboard objects with id and name.
+        """
+        response = await self._client.get("/companies/dashboards")
+        response.raise_for_status()
+        data = self._client._parse_json_response(response)
+        return data if isinstance(data, list) else []