field-manager-python-client 4.6.239__tar.gz → 4.7.16__tar.gz

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/PKG-INFO

@@ -1,20 +1,19 @@
 Metadata-Version: 2.1
 Name: field-manager-python-client
-Version: 4.6.239
+Version: 4.7.16
 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
+Requires-Python: >=3.11,<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-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: python-keycloak (>=5.5.0,<6.0.0)
 Description-Content-Type: text/markdown
 
@@ -31,13 +30,12 @@ pip install field_manager_python_client python-keycloak
 
 ### Authentication
 
-The easiest way to get started is using the built-in authentication functions:
+The easiest way to get started for scripting is using the built-in device-code helper:
 
 ```python
-from field_manager_python_client import get_prod_client
+from field_manager_python_client import get_prod_device_code_client
 
-# Authenticate with your Field Manager account
-client = get_prod_client(email="your.email@example.com")
+client = get_prod_device_code_client()
 ```
 
 ### Basic Usage
@@ -46,33 +44,28 @@ client = get_prod_client(email="your.email@example.com")
 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"
-)
+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)
+### 1. Device Code Authentication (Recommended)
 ```python
-from field_manager_python_client import authenticate
+from field_manager_python_client import authenticate_with_device_code
 
-client = authenticate(environment="prod", email="user@example.com")
+client = authenticate_with_device_code(environment="prod")
 ```
 
 ### 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"
-)
+client = AuthenticatedClient(base_url="https://app.fieldmanager.io/api/location", token="your-access-token")
 ```
 
 ### 3. Service Account (for automation)
+Use a dedicated Keycloak client created for your integration
 See the [main repository](https://github.com/norwegian-geotechnical-institute/field-manager-python-client) for service account setup.
 
 ## 📖 API Usage Patterns
@@ -86,6 +79,7 @@ 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
@@ -96,14 +90,16 @@ if response.status_code == 200:
 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())
 ```
@@ -116,33 +112,30 @@ 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"
+    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
-)
+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]}}
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
 )
 ```
 

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/README.md

@@ -11,13 +11,12 @@ pip install field_manager_python_client python-keycloak
 
 ### Authentication
 
-The easiest way to get started is using the built-in authentication functions:
+The easiest way to get started for scripting is using the built-in device-code helper:
 
 ```python
-from field_manager_python_client import get_prod_client
+from field_manager_python_client import get_prod_device_code_client
 
-# Authenticate with your Field Manager account
-client = get_prod_client(email="your.email@example.com")
+client = get_prod_device_code_client()
 ```
 
 ### Basic Usage
@@ -26,33 +25,28 @@ client = get_prod_client(email="your.email@example.com")
 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"
-)
+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)
+### 1. Device Code Authentication (Recommended)
 ```python
-from field_manager_python_client import authenticate
+from field_manager_python_client import authenticate_with_device_code
 
-client = authenticate(environment="prod", email="user@example.com")
+client = authenticate_with_device_code(environment="prod")
 ```
 
 ### 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"
-)
+client = AuthenticatedClient(base_url="https://app.fieldmanager.io/api/location", token="your-access-token")
 ```
 
 ### 3. Service Account (for automation)
+Use a dedicated Keycloak client created for your integration
 See the [main repository](https://github.com/norwegian-geotechnical-institute/field-manager-python-client) for service account setup.
 
 ## 📖 API Usage Patterns
@@ -66,6 +60,7 @@ 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
@@ -76,14 +71,16 @@ if response.status_code == 200:
 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())
 ```
@@ -96,33 +93,30 @@ 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"
+    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
-)
+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]}}
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
 )
 ```
 

field_manager_python_client-4.7.16/field_manager_python_client/__init__.py

@@ -0,0 +1,20 @@
+"""A client library for accessing Field Manager Data API"""
+
+from .auth import (
+    TokenManager,
+    authenticate_with_device_code,
+    get_prod_device_code_client,
+    get_service_account_client,
+    get_test_device_code_client,
+)
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+    "authenticate_with_device_code",
+    "get_test_device_code_client",
+    "get_prod_device_code_client",
+    "get_service_account_client",
+    "TokenManager",
+)

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/field_manager_python_client/api/cross_sections/create_cross_section_lines_projects_project_id_cross_sections_lines_format_post.py

@@ -84,7 +84,7 @@ def sync_detailed(
 ) -> Response[Any | HTTPValidationError]:
     """Create Cross Section Lines
 
-     Get a dxf file or shapefile bundle containing the cross section lines
+     Get a dxf file or shapefile bundle containing the cross-section lines
 
     Args:
         project_id (str):
@@ -121,7 +121,7 @@ def sync(
 ) -> Any | HTTPValidationError | None:
     """Create Cross Section Lines
 
-     Get a dxf file or shapefile bundle containing the cross section lines
+     Get a dxf file or shapefile bundle containing the cross-section lines
 
     Args:
         project_id (str):
@@ -153,7 +153,7 @@ async def asyncio_detailed(
 ) -> Response[Any | HTTPValidationError]:
     """Create Cross Section Lines
 
-     Get a dxf file or shapefile bundle containing the cross section lines
+     Get a dxf file or shapefile bundle containing the cross-section lines
 
     Args:
         project_id (str):
@@ -188,7 +188,7 @@ async def asyncio(
 ) -> Any | HTTPValidationError | None:
     """Create Cross Section Lines
 
-     Get a dxf file or shapefile bundle containing the cross section lines
+     Get a dxf file or shapefile bundle containing the cross-section lines
 
     Args:
         project_id (str):

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/field_manager_python_client/api/cross_sections/create_cross_section_projects_project_id_cross_sections_post.py

@@ -72,7 +72,7 @@ def sync_detailed(
 ) -> Response[CrossSection | HTTPValidationError]:
     """Create Cross Section
 
-     Create a new cross section for a project.
+     Create a new cross-section for a project.
 
     Args:
         project_id (str):
@@ -106,7 +106,7 @@ def sync(
 ) -> CrossSection | HTTPValidationError | None:
     """Create Cross Section
 
-     Create a new cross section for a project.
+     Create a new cross-section for a project.
 
     Args:
         project_id (str):
@@ -135,7 +135,7 @@ async def asyncio_detailed(
 ) -> Response[CrossSection | HTTPValidationError]:
     """Create Cross Section
 
-     Create a new cross section for a project.
+     Create a new cross-section for a project.
 
     Args:
         project_id (str):
@@ -167,7 +167,7 @@ async def asyncio(
 ) -> CrossSection | HTTPValidationError | None:
     """Create Cross Section
 
-     Create a new cross section for a project.
+     Create a new cross-section for a project.
 
     Args:
         project_id (str):

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/field_manager_python_client/api/cross_sections/delete_cross_section_projects_project_id_cross_sections_cross_section_id_delete.py

@@ -64,7 +64,7 @@ def sync_detailed(
 ) -> Response[Any | HTTPValidationError]:
     """Delete Cross Section
 
-     Delete a cross section.
+     Delete a cross-section
 
     Args:
         project_id (str):
@@ -98,7 +98,7 @@ def sync(
 ) -> Any | HTTPValidationError | None:
     """Delete Cross Section
 
-     Delete a cross section.
+     Delete a cross-section
 
     Args:
         project_id (str):
@@ -127,7 +127,7 @@ async def asyncio_detailed(
 ) -> Response[Any | HTTPValidationError]:
     """Delete Cross Section
 
-     Delete a cross section.
+     Delete a cross-section
 
     Args:
         project_id (str):
@@ -159,7 +159,7 @@ async def asyncio(
 ) -> Any | HTTPValidationError | None:
     """Delete Cross Section
 
-     Delete a cross section.
+     Delete a cross-section
 
     Args:
         project_id (str):

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/field_manager_python_client/api/cross_sections/get_cross_section_projects_project_id_cross_sections_cross_section_id_get.py

@@ -66,7 +66,7 @@ def sync_detailed(
 ) -> Response[CrossSection | HTTPValidationError]:
     """Get Cross Section
 
-     Get a cross section.
+     Get a cross-section.
 
     Args:
         project_id (str):
@@ -100,7 +100,7 @@ def sync(
 ) -> CrossSection | HTTPValidationError | None:
     """Get Cross Section
 
-     Get a cross section.
+     Get a cross-section.
 
     Args:
         project_id (str):
@@ -129,7 +129,7 @@ async def asyncio_detailed(
 ) -> Response[CrossSection | HTTPValidationError]:
     """Get Cross Section
 
-     Get a cross section.
+     Get a cross-section.
 
     Args:
         project_id (str):
@@ -161,7 +161,7 @@ async def asyncio(
 ) -> CrossSection | HTTPValidationError | None:
     """Get Cross Section
 
-     Get a cross section.
+     Get a cross-section.
 
     Args:
         project_id (str):

{field_manager_python_client-4.6.239 → field_manager_python_client-4.7.16}/field_manager_python_client/api/cross_sections/get_cross_sections_for_project_projects_project_id_cross_sections_get.py

@@ -67,7 +67,7 @@ def sync_detailed(
 ) -> Response[HTTPValidationError | list[CrossSection]]:
     """Get Cross Sections For Project
 
-     Get non-deleted cross sections for a project.
+     Get non-deleted cross-sections for a project.
 
     Args:
         project_id (str):
@@ -98,7 +98,7 @@ def sync(
 ) -> HTTPValidationError | list[CrossSection] | None:
     """Get Cross Sections For Project
 
-     Get non-deleted cross sections for a project.
+     Get non-deleted cross-sections for a project.
 
     Args:
         project_id (str):
@@ -124,7 +124,7 @@ async def asyncio_detailed(
 ) -> Response[HTTPValidationError | list[CrossSection]]:
     """Get Cross Sections For Project
 
-     Get non-deleted cross sections for a project.
+     Get non-deleted cross-sections for a project.
 
     Args:
         project_id (str):
@@ -153,7 +153,7 @@ async def asyncio(
 ) -> HTTPValidationError | list[CrossSection] | None:
     """Get Cross Sections For Project
 
-     Get non-deleted cross sections for a project.
+     Get non-deleted cross-sections for a project.
 
     Args:
         project_id (str):

field_manager_python_client-4.7.16/field_manager_python_client/api/layer_interpretations/create_organization_layer_group_organizations_organization_id_layer_groups_post.py

@@ -0,0 +1,190 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.layer_group_with_soil_units import LayerGroupWithSoilUnits
+from ...models.organization_layer_group_create import OrganizationLayerGroupCreate
+from ...types import Response
+
+
+def _get_kwargs(
+    organization_id: str,
+    *,
+    body: OrganizationLayerGroupCreate,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/organizations/{organization_id}/layer-groups".format(
+            organization_id=quote(str(organization_id), safe=""),
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | LayerGroupWithSoilUnits | None:
+    if response.status_code == 201:
+        response_201 = LayerGroupWithSoilUnits.from_dict(response.json())
+
+        return response_201
+
+    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: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | LayerGroupWithSoilUnits]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: OrganizationLayerGroupCreate,
+) -> Response[HTTPValidationError | LayerGroupWithSoilUnits]:
+    """Create Organization Layer Group
+
+     Create an organization layer group template.
+
+    Args:
+        organization_id (str):
+        body (OrganizationLayerGroupCreate):
+
+    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[HTTPValidationError | LayerGroupWithSoilUnits]
+    """
+
+    kwargs = _get_kwargs(
+        organization_id=organization_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: OrganizationLayerGroupCreate,
+) -> HTTPValidationError | LayerGroupWithSoilUnits | None:
+    """Create Organization Layer Group
+
+     Create an organization layer group template.
+
+    Args:
+        organization_id (str):
+        body (OrganizationLayerGroupCreate):
+
+    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:
+        HTTPValidationError | LayerGroupWithSoilUnits
+    """
+
+    return sync_detailed(
+        organization_id=organization_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: OrganizationLayerGroupCreate,
+) -> Response[HTTPValidationError | LayerGroupWithSoilUnits]:
+    """Create Organization Layer Group
+
+     Create an organization layer group template.
+
+    Args:
+        organization_id (str):
+        body (OrganizationLayerGroupCreate):
+
+    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[HTTPValidationError | LayerGroupWithSoilUnits]
+    """
+
+    kwargs = _get_kwargs(
+        organization_id=organization_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+    body: OrganizationLayerGroupCreate,
+) -> HTTPValidationError | LayerGroupWithSoilUnits | None:
+    """Create Organization Layer Group
+
+     Create an organization layer group template.
+
+    Args:
+        organization_id (str):
+        body (OrganizationLayerGroupCreate):
+
+    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:
+        HTTPValidationError | LayerGroupWithSoilUnits
+    """
+
+    return (
+        await asyncio_detailed(
+            organization_id=organization_id,
+            client=client,
+            body=body,
+        )
+    ).parsed