field-manager-python-client 4.6.25.post3__tar.gz → 4.6.25.post4__tar.gz

field_manager_python_client-4.6.25.post4/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: field-manager-python-client
+Version: 4.6.25.post4
+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.25.post4/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.25.post3 → field_manager_python_client-4.6.25.post4}/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.25.post4}/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.25.post4}/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.25.post4}/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

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.25.post4}/field_manager_python_client/api/export/export_projects_project_id_export_post.py

@@ -22,9 +22,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/export",
     }
 
-    _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.25.post4}/field_manager_python_client/api/files/change_file_metadata_projects_project_id_files_file_id_put.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/files/{file_id}",
     }
 
-    _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.25.post4}/field_manager_python_client/api/locations/add_location_to_project_projects_project_id_locations_post.py

@@ -23,9 +23,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations",
     }
 
-    _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.25.post4}/field_manager_python_client/api/locations/delete_locations_in_project_projects_project_id_locations_delete.py

@@ -22,12 +22,11 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations",
     }
 
-    _body = []
+    _kwargs["json"] = []
     for body_item_data in body:
         body_item = str(body_item_data)
-        _body.append(body_item)
+        _kwargs["json"].append(body_item)
 
-    _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.25.post4}/field_manager_python_client/api/locations/queue_locations_to_project_projects_project_id_locations_queue_post.py

@@ -46,9 +46,7 @@ def _get_kwargs(
         "params": params,
     }
 
-    _body = body.to_multipart()
-
-    _kwargs["files"] = _body
+    _kwargs["files"] = body.to_multipart()
 
     _kwargs["headers"] = headers
     return _kwargs

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.25.post4}/field_manager_python_client/api/locations/update_location_in_project_projects_project_id_locations_location_id_put.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations/{location_id}",
     }
 
-    _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.25.post4}/field_manager_python_client/api/locations/update_locations_in_project_projects_project_id_locations_put.py

@@ -23,12 +23,11 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations",
     }
 
-    _body = []
+    _kwargs["json"] = []
     for body_item_data in body:
         body_item = body_item_data.to_dict()
-        _body.append(body_item)
+        _kwargs["json"].append(body_item)
 
-    _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.25.post4}/field_manager_python_client/api/locations/upload_file_to_location_projects_project_id_locations_location_id_upload_post.py

@@ -54,9 +54,7 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations/{location_id}/upload",
     }
 
-    _body = body.to_multipart()
-
-    _kwargs["files"] = _body
+    _kwargs["files"] = body.to_multipart()
 
     _kwargs["headers"] = headers
     return _kwargs

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.25.post4}/field_manager_python_client/api/locations/upload_locations_to_project_projects_project_id_locations_upload_post.py

@@ -46,9 +46,7 @@ def _get_kwargs(
         "params": params,
     }
 
-    _body = body.to_multipart()
-
-    _kwargs["files"] = _body
+    _kwargs["files"] = body.to_multipart()
 
     _kwargs["headers"] = headers
     return _kwargs

{field_manager_python_client-4.6.25.post3 → field_manager_python_client-4.6.25.post4}/field_manager_python_client/api/map_layouts/add_map_layout_to_project_projects_project_id_map_layouts_post.py

@@ -23,9 +23,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/map_layouts",
     }
 
-    _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.25.post4}/field_manager_python_client/api/map_layouts/add_map_layout_version_projects_project_id_map_layouts_map_layout_id_versions_post.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/map_layouts/{map_layout_id}/versions",
     }
 
-    _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.25.post4}/field_manager_python_client/api/map_layouts/delete_map_layouts_in_project_projects_project_id_map_layouts_delete.py

@@ -22,12 +22,11 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/map_layouts",
     }
 
-    _body = []
+    _kwargs["json"] = []
     for body_item_data in body:
         body_item = str(body_item_data)
-        _body.append(body_item)
+        _kwargs["json"].append(body_item)
 
-    _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.25.post4}/field_manager_python_client/api/map_layouts/update_map_layout_in_project_projects_project_id_map_layouts_map_layout_id_put.py

@@ -25,9 +25,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/map_layouts/{map_layout_id}",
     }
 
-    _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.25.post4}/field_manager_python_client/api/map_layouts/update_map_layout_version_projects_project_id_map_layouts_map_layout_id_versions_map_layout_version_id_put.py

@@ -26,9 +26,8 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/map_layouts/{map_layout_id}/versions/{map_layout_version_id}",
     }
 
-    _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.25.post4}/field_manager_python_client/api/methods/add_method_to_location_projects_project_id_locations_location_id_methods_post.py

@@ -108,65 +108,64 @@ def _get_kwargs(
         "url": f"/projects/{project_id}/locations/{location_id}/methods",
     }
 
-    _body: dict[str, Any]
+    _kwargs["json"]: dict[str, Any]
     if isinstance(body, MethodADCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodCDCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodCPTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodDPCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodDTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodESACreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodINCCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodIWCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodOTHERCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodPTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodPZCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodRCDCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodROCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodRPCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodRSCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodRWSCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSACreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSLBCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSPTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodDEFCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSRSCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSSCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSTICreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodSVTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodTOTCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodTPCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     elif isinstance(body, MethodTRCreate):
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
     else:
-        _body = body.to_dict()
+        _kwargs["json"] = body.to_dict()
 
-    _kwargs["json"] = _body
     headers["Content-Type"] = "application/json"
 
     _kwargs["headers"] = headers