field-manager-python-client 4.6.25.post3__tar.gz → 4.6.37__tar.gz

field_manager_python_client-4.6.37/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: field-manager-python-client
+Version: 4.6.37
+Summary: A client library for accessing Field Manager Data API
+Author: Jiyang Ye
+Author-email: jiyang.ye@ngi.no
+Maintainer: Jiyang Ye
+Maintainer-email: jiyang.ye@ngi.no
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: attrs (>=22.2.0)
+Requires-Dist: httpx (>=0.23.0,<0.29.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
+Requires-Dist: python-keycloak (>=5.5.0,<6.0.0)
+Description-Content-Type: text/markdown
+
+# field-manager-python-client
+A client library for accessing Field Manager Data API
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install field_manager_python_client python-keycloak
+```
+
+### Authentication
+
+The easiest way to get started is using the built-in authentication functions:
+
+```python
+from field_manager_python_client import get_prod_client
+
+# Authenticate with your Field Manager account
+client = get_prod_client(email="your.email@example.com")
+```
+
+### Basic Usage
+
+```python
+from field_manager_python_client.api.projects import get_project_projects_project_id_get
+
+# Use the authenticated client
+project_info = get_project_projects_project_id_get.sync(
+    client=client, 
+    project_id="your-project-id"
+)
+print(f"Project: {project_info.name}")
+```
+
+## 🔐 Authentication Options
+
+### 1. Integrated Authentication (Recommended)
+```python
+from field_manager_python_client import authenticate
+
+client = authenticate(environment="prod", email="user@example.com")
+```
+
+### 2. Manual Token Setup
+```python
+from field_manager_python_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://app.fieldmanager.io/api/location", 
+    token="your-access-token"
+)
+```
+
+### 3. Service Account (for automation)
+See the [main repository](https://github.com/norwegian-geotechnical-institute/field-manager-python-client) for service account setup.
+
+## 📖 API Usage Patterns
+
+### Synchronous Operations
+```python
+from field_manager_python_client.api.organizations import get_organizations_organizations_get
+
+# Simple request - returns data or None
+organizations = get_organizations_organizations_get.sync(client=client)
+
+# Detailed request - returns Response object with status code, headers, etc.
+from field_manager_python_client.types import Response
+response: Response = get_organizations_organizations_get.sync_detailed(client=client)
+if response.status_code == 200:
+    organizations = response.parsed
+```
+
+### Asynchronous Operations
+```python
+import asyncio
+from field_manager_python_client.api.organizations import get_organizations_organizations_get
+
+async def fetch_organizations():
+    # Simple async request
+    organizations = await get_organizations_organizations_get.asyncio(client=client)
+    
+    # Detailed async request
+    response = await get_organizations_organizations_get.asyncio_detailed(client=client)
+    return response.parsed
+
+# Run async function
+organizations = asyncio.run(fetch_organizations())
+```
+
+## 🛠️ Advanced Features
+
+### SSL Configuration
+```python
+from field_manager_python_client import AuthenticatedClient
+
+# Custom certificate bundle
+client = AuthenticatedClient(
+    base_url="https://internal.example.com/api", 
+    token="token",
+    verify_ssl="/path/to/certificate_bundle.pem"
+)
+
+# Disable SSL verification (not recommended for production)
+client = AuthenticatedClient(
+    base_url="https://internal.example.com/api", 
+    token="token",
+    verify_ssl=False
+)
+```
+
+### Custom HTTP Configuration
+```python
+from field_manager_python_client import AuthenticatedClient
+
+def log_request(request):
+    print(f"Request: {request.method} {request.url}")
+
+def log_response(response):
+    print(f"Response: {response.status_code}")
+
+client = AuthenticatedClient(
+    base_url="https://api.example.com",
+    token="token",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}}
+)
+```
+
+## 📚 Learn More
+
+For comprehensive documentation, examples, and contribution guidelines, visit the main repository:
+**[https://github.com/norwegian-geotechnical-institute/field-manager-python-client](https://github.com/norwegian-geotechnical-institute/field-manager-python-client)**
+
+The repository includes:
+- 📖 Complete authentication guide
+- 🔧 Advanced usage examples  
+- 🚀 Real-world code samples
+- 🤝 Contributing guidelines
+- 📋 Issue tracking and support
+
+## 🔍 API Reference
+
+Every endpoint becomes a Python function with four variants:
+- `sync`: Blocking request returning parsed data or `None`
+- `sync_detailed`: Blocking request returning full `Response` object
+- `asyncio`: Async version of `sync`  
+- `asyncio_detailed`: Async version of `sync_detailed`
+
+All path/query parameters and request bodies become function arguments.
+Functions are organized by API tags in `field_manager_python_client.api.*` modules.
+

field_manager_python_client-4.6.37/README.md

@@ -0,0 +1,150 @@
+# field-manager-python-client
+A client library for accessing Field Manager Data API
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+pip install field_manager_python_client python-keycloak
+```
+
+### Authentication
+
+The easiest way to get started is using the built-in authentication functions:
+
+```python
+from field_manager_python_client import get_prod_client
+
+# Authenticate with your Field Manager account
+client = get_prod_client(email="your.email@example.com")
+```
+
+### Basic Usage
+
+```python
+from field_manager_python_client.api.projects import get_project_projects_project_id_get
+
+# Use the authenticated client
+project_info = get_project_projects_project_id_get.sync(
+    client=client, 
+    project_id="your-project-id"
+)
+print(f"Project: {project_info.name}")
+```
+
+## 🔐 Authentication Options
+
+### 1. Integrated Authentication (Recommended)
+```python
+from field_manager_python_client import authenticate
+
+client = authenticate(environment="prod", email="user@example.com")
+```
+
+### 2. Manual Token Setup
+```python
+from field_manager_python_client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://app.fieldmanager.io/api/location", 
+    token="your-access-token"
+)
+```
+
+### 3. Service Account (for automation)
+See the [main repository](https://github.com/norwegian-geotechnical-institute/field-manager-python-client) for service account setup.
+
+## 📖 API Usage Patterns
+
+### Synchronous Operations
+```python
+from field_manager_python_client.api.organizations import get_organizations_organizations_get
+
+# Simple request - returns data or None
+organizations = get_organizations_organizations_get.sync(client=client)
+
+# Detailed request - returns Response object with status code, headers, etc.
+from field_manager_python_client.types import Response
+response: Response = get_organizations_organizations_get.sync_detailed(client=client)
+if response.status_code == 200:
+    organizations = response.parsed
+```
+
+### Asynchronous Operations
+```python
+import asyncio
+from field_manager_python_client.api.organizations import get_organizations_organizations_get
+
+async def fetch_organizations():
+    # Simple async request
+    organizations = await get_organizations_organizations_get.asyncio(client=client)
+    
+    # Detailed async request
+    response = await get_organizations_organizations_get.asyncio_detailed(client=client)
+    return response.parsed
+
+# Run async function
+organizations = asyncio.run(fetch_organizations())
+```
+
+## 🛠️ Advanced Features
+
+### SSL Configuration
+```python
+from field_manager_python_client import AuthenticatedClient
+
+# Custom certificate bundle
+client = AuthenticatedClient(
+    base_url="https://internal.example.com/api", 
+    token="token",
+    verify_ssl="/path/to/certificate_bundle.pem"
+)
+
+# Disable SSL verification (not recommended for production)
+client = AuthenticatedClient(
+    base_url="https://internal.example.com/api", 
+    token="token",
+    verify_ssl=False
+)
+```
+
+### Custom HTTP Configuration
+```python
+from field_manager_python_client import AuthenticatedClient
+
+def log_request(request):
+    print(f"Request: {request.method} {request.url}")
+
+def log_response(response):
+    print(f"Response: {response.status_code}")
+
+client = AuthenticatedClient(
+    base_url="https://api.example.com",
+    token="token",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}}
+)
+```
+
+## 📚 Learn More
+
+For comprehensive documentation, examples, and contribution guidelines, visit the main repository:
+**[https://github.com/norwegian-geotechnical-institute/field-manager-python-client](https://github.com/norwegian-geotechnical-institute/field-manager-python-client)**
+
+The repository includes:
+- 📖 Complete authentication guide
+- 🔧 Advanced usage examples  
+- 🚀 Real-world code samples
+- 🤝 Contributing guidelines
+- 📋 Issue tracking and support
+
+## 🔍 API Reference
+
+Every endpoint becomes a Python function with four variants:
+- `sync`: Blocking request returning parsed data or `None`
+- `sync_detailed`: Blocking request returning full `Response` object
+- `asyncio`: Async version of `sync`  
+- `asyncio_detailed`: Async version of `sync_detailed`
+
+All path/query parameters and request bodies become function arguments.
+Functions are organized by API tags in `field_manager_python_client.api.*` modules.

field_manager_python_client-4.6.37/field_manager_python_client/api/comments/get_location_comments_projects_project_id_locations_location_id_comments_get.py

@@ -0,0 +1,182 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.comment import Comment
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+    location_id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/projects/{project_id}/locations/{location_id}/comments",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[HTTPValidationError, list["Comment"]]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = Comment.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[HTTPValidationError, list["Comment"]]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    location_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[HTTPValidationError, list["Comment"]]]:
+    """Get Location Comments
+
+     Get all location comments, along with associated likes
+
+    Args:
+        project_id (str):
+        location_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, list['Comment']]]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        location_id=location_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    project_id: str,
+    location_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[HTTPValidationError, list["Comment"]]]:
+    """Get Location Comments
+
+     Get all location comments, along with associated likes
+
+    Args:
+        project_id (str):
+        location_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, list['Comment']]
+    """
+
+    return sync_detailed(
+        project_id=project_id,
+        location_id=location_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    project_id: str,
+    location_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[HTTPValidationError, list["Comment"]]]:
+    """Get Location Comments
+
+     Get all location comments, along with associated likes
+
+    Args:
+        project_id (str):
+        location_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, list['Comment']]]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        location_id=location_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    project_id: str,
+    location_id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[HTTPValidationError, list["Comment"]]]:
+    """Get Location Comments
+
+     Get all location comments, along with associated likes
+
+    Args:
+        project_id (str):
+        location_id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, list['Comment']]
+    """
+
+    return (
+        await asyncio_detailed(
+            project_id=project_id,
+            location_id=location_id,
+            client=client,
+        )
+    ).parsed

field_manager_python_client-4.6.25.post3/field_manager_python_client/api/comments/get_comments_projects_project_id_locations_location_id_comments_get.py → field_manager_python_client-4.6.37/field_manager_python_client/api/comments/get_method_comments_projects_project_id_locations_location_id_methods_method_id_comments_get.py

@@ -8,32 +8,17 @@ from ... import errors
 from ...client import AuthenticatedClient, Client
 from ...models.comment import Comment
 from ...models.http_validation_error import HTTPValidationError
-from ...types import UNSET, Response, Unset
+from ...types import Response
 
 
 def _get_kwargs(
     project_id: str,
     location_id: UUID,
-    *,
-    method_id: Union[None, UUID, Unset] = UNSET,
+    method_id: UUID,
 ) -> dict[str, Any]:
-    params: dict[str, Any] = {}
-
-    json_method_id: Union[None, Unset, str]
-    if isinstance(method_id, Unset):
-        json_method_id = UNSET
-    elif isinstance(method_id, UUID):
-        json_method_id = str(method_id)
-    else:
-        json_method_id = method_id
-    params["method_id"] = json_method_id
-
-    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
-
     _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": f"/projects/{project_id}/locations/{location_id}/comments",
-        "params": params,
+        "url": f"/projects/{project_id}/locations/{location_id}/methods/{method_id}/comments",
     }
 
     return _kwargs
@@ -75,18 +60,18 @@ def _build_response(
 def sync_detailed(
     project_id: str,
     location_id: UUID,
+    method_id: UUID,
     *,
     client: AuthenticatedClient,
-    method_id: Union[None, UUID, Unset] = UNSET,
 ) -> Response[Union[HTTPValidationError, list["Comment"]]]:
-    """Get Comments
+    """Get Method Comments
 
-     Get all non-deleted comments, along with associated likes, on a given method or location
+     Get all method comments, along with associated likes, on a given method
 
     Args:
         project_id (str):
         location_id (UUID):
-        method_id (Union[None, UUID, Unset]):
+        method_id (UUID):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -112,18 +97,18 @@ def sync_detailed(
 def sync(
     project_id: str,
     location_id: UUID,
+    method_id: UUID,
     *,
     client: AuthenticatedClient,
-    method_id: Union[None, UUID, Unset] = UNSET,
 ) -> Optional[Union[HTTPValidationError, list["Comment"]]]:
-    """Get Comments
+    """Get Method Comments
 
-     Get all non-deleted comments, along with associated likes, on a given method or location
+     Get all method comments, along with associated likes, on a given method
 
     Args:
         project_id (str):
         location_id (UUID):
-        method_id (Union[None, UUID, Unset]):
+        method_id (UUID):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -136,26 +121,26 @@ def sync(
     return sync_detailed(
         project_id=project_id,
         location_id=location_id,
-        client=client,
         method_id=method_id,
+        client=client,
     ).parsed
 
 
 async def asyncio_detailed(
     project_id: str,
     location_id: UUID,
+    method_id: UUID,
     *,
     client: AuthenticatedClient,
-    method_id: Union[None, UUID, Unset] = UNSET,
 ) -> Response[Union[HTTPValidationError, list["Comment"]]]:
-    """Get Comments
+    """Get Method Comments
 
-     Get all non-deleted comments, along with associated likes, on a given method or location
+     Get all method comments, along with associated likes, on a given method
 
     Args:
         project_id (str):
         location_id (UUID):
-        method_id (Union[None, UUID, Unset]):
+        method_id (UUID):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -179,18 +164,18 @@ async def asyncio_detailed(
 async def asyncio(
     project_id: str,
     location_id: UUID,
+    method_id: UUID,
     *,
     client: AuthenticatedClient,
-    method_id: Union[None, UUID, Unset] = UNSET,
 ) -> Optional[Union[HTTPValidationError, list["Comment"]]]:
-    """Get Comments
+    """Get Method Comments
 
-     Get all non-deleted comments, along with associated likes, on a given method or location
+     Get all method comments, along with associated likes, on a given method
 
     Args:
         project_id (str):
         location_id (UUID):
-        method_id (Union[None, UUID, Unset]):
+        method_id (UUID):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -204,7 +189,7 @@ async def asyncio(
         await asyncio_detailed(
             project_id=project_id,
             location_id=location_id,
-            client=client,
             method_id=method_id,
+            client=client,
         )
     ).parsed

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.37}/field_manager_python_client/api/comments/modify_comment_projects_project_id_locations_location_id_comments_comment_id_text_put.py

@@ -41,9 +41,8 @@ def _get_kwargs(
         "params": params,
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.37}/field_manager_python_client/api/comments/submit_comment_projects_project_id_locations_location_id_comments_post.py

@@ -40,9 +40,8 @@ def _get_kwargs(
         "params": params,
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.37}/field_manager_python_client/api/cross_sections/create_cross_section_projects_project_id_cross_sections_post.py

@@ -23,9 +23,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/cross_sections",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.37}/field_manager_python_client/api/cross_sections/update_cross_section_projects_project_id_cross_sections_cross_section_id_put.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/cross_sections/{cross_section_id}",
     }
 
-    _body = body.to_dict()
+    _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers