fairagro-middleware-api-client 8.6.2__tar.gz

fairagro_middleware_api_client-8.6.2/.gitignore

@@ -0,0 +1,229 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Allow encrypted .env.integration.enc but ignore any unencrypted .env files
+!.env.integration.enc
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+scratch/
+**/*.csv
+**/*.stats
+
+**/*.decrypted.*
+
+# Cryptographic keys and certificates for testing that are not meant to be committed
+helmchart/**/*.crt
+helmchart/**/*.key
+helmchart/**/*.csr
+helmchart/**/*.srl
+helmchart/**/server.conf
+helmchart/**/client_ext.conf
+
+# ggshield cache
+.cache_ggshield
+
+docker/Dockerfile.api.bak

fairagro_middleware_api_client-8.6.2/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: fairagro-middleware-api-client
+Version: 8.6.2
+Summary: The FAIRagro advanced middleware API client
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Description-Content-Type: text/markdown
+
+# Middleware API Client
+
+Python client for the FAIRagro Middleware API with certificate-based authentication (mTLS).
+
+## Features
+
+- ✅ Certificate-based authentication (mutual TLS)
+- ✅ Configuration via YAML files, environment variables, or Docker secrets
+- ✅ Async context manager support
+- ✅ Comprehensive error handling
+- ✅ Type-safe with Pydantic models
+
+## Installation
+
+This package is part of the FAIRagro Advanced Middleware project and uses local dependencies.
+
+## Quick Start
+
+### 1. Create Configuration File
+
+```yaml
+# config.yaml
+log_level: INFO
+api_url: https://your-api-server:8000
+client_cert_path: /path/to/client-cert.pem
+client_key_path: /path/to/client-key.pem
+ca_cert_path: /path/to/ca-cert.pem  # optional
+timeout: 30.0
+verify_ssl: true
+```
+
+### 2. Use the Client
+
+```python
+import asyncio
+from pathlib import Path
+from arctrl import ARC, ArcInvestigation
+from middleware.api_client import Config, ApiClient
+
+
+async def main():
+    # Load configuration
+    config = Config.from_yaml_file(Path("config.yaml"))
+
+    # Create ARC object
+    inv = ArcInvestigation.create(identifier="my-arc", title="My ARC")
+    arc = ARC.from_arc_investigation(inv)
+
+    # Use client with context manager
+    async with ApiClient(config) as client:
+        # Send a single ARC
+        response = await client.create_or_update_arc(
+            rdi="my-rdi",
+            arc=arc,
+        )
+        print(f"ARC status: {response.status}")
+
+        # Or run a harvest workflow
+        async def arc_stream():
+            yield arc
+
+        harvest = await client.harvest_arcs(
+            rdi="my-rdi",
+            arcs=arc_stream(),
+            expected_datasets=1,
+        )
+        print(f"Harvest status: {harvest.status}")
+
+
+asyncio.run(main())
+```
+
+## Configuration Options
+
+| Option | Type | Required | Default | Description |
+| ------ | ---- | -------- | ------- | ----------- |
+| `log_level` | string | No | INFO | Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
+| `api_url` | string | Yes | - | Base URL of the Middleware API |
+| `client_cert_path` | string | No | null | Path to client certificate (PEM format) |
+| `client_key_path` | string | No | null | Path to client private key (PEM format) |
+| `ca_cert_path` | string | No | null | Path to CA certificate for server verification |
+| `timeout` | float | No | 30.0 | Request timeout in seconds |
+| `verify_ssl` | bool | No | true | Enable SSL certificate verification |
+| `max_concurrency` | int | No | 10 | Maximum concurrent API requests (also default for `harvest_arcs`) |
+
+## API Methods
+
+### `create_or_update_arc(rdi: str, arc: ARC | dict) -> ArcResult`
+
+Create or update one ARC in the Middleware API.
+
+**Parameters:**
+
+- `rdi` (str): The RDI identifier (e.g., "edaphobase").
+- `arc` (ARC | dict): ARC object from arctrl or pre-serialised RO-Crate dict.
+
+**Returns:**
+
+- `ArcResult`: Contains the result of the operation.
+
+**Raises:**
+
+- `ApiClientError`: If the request fails due to HTTP errors or network issues.
+
+**Example:**
+
+```python
+from arctrl import ARC, ArcInvestigation
+
+inv = ArcInvestigation.create(identifier="my-arc-001", title="My ARC")
+arc = ARC.from_arc_investigation(inv)
+
+response = await client.create_or_update_arc(
+    rdi="edaphobase",
+    arc=arc,
+)
+```
+
+### `harvest_arcs(rdi: str, arcs: AsyncIterator[ARC | dict], expected_datasets: int | None = None) -> HarvestResult`
+
+Convenience workflow to create a harvest, upload all ARCs from an async iterator, and complete the harvest.
+
+- Uses `config.max_concurrency` by default.
+- Continues on item-level submission errors and skips failed items.
+- Cancels the harvest only for catastrophic errors.
+
+All errors are raised as `ApiClientError` exceptions:
+
+```python
+from middleware.api_client import ApiClientError
+
+try:
+    response = await client.create_or_update_arc(
+        rdi="my-rdi",
+        arc=arc,
+    )
+except ApiClientError as e:
+    print(f"API Error: {e}")
+```
+
+## Configuration via Environment Variables
+
+You can override configuration values using environment variables:
+
+```bash
+export API_URL="https://production-api:8000"
+export CLIENT_CERT_PATH="/secure/certs/prod-cert.pem"
+export CLIENT_KEY_PATH="/secure/certs/prod-key.pem"
+```
+
+Or use Docker secrets in `/run/secrets/`.
+
+## License
+
+This is part of the FAIRagro Advanced Middleware project.

fairagro_middleware_api_client-8.6.2/README.md

@@ -0,0 +1,155 @@
+# Middleware API Client
+
+Python client for the FAIRagro Middleware API with certificate-based authentication (mTLS).
+
+## Features
+
+- ✅ Certificate-based authentication (mutual TLS)
+- ✅ Configuration via YAML files, environment variables, or Docker secrets
+- ✅ Async context manager support
+- ✅ Comprehensive error handling
+- ✅ Type-safe with Pydantic models
+
+## Installation
+
+This package is part of the FAIRagro Advanced Middleware project and uses local dependencies.
+
+## Quick Start
+
+### 1. Create Configuration File
+
+```yaml
+# config.yaml
+log_level: INFO
+api_url: https://your-api-server:8000
+client_cert_path: /path/to/client-cert.pem
+client_key_path: /path/to/client-key.pem
+ca_cert_path: /path/to/ca-cert.pem  # optional
+timeout: 30.0
+verify_ssl: true
+```
+
+### 2. Use the Client
+
+```python
+import asyncio
+from pathlib import Path
+from arctrl import ARC, ArcInvestigation
+from middleware.api_client import Config, ApiClient
+
+
+async def main():
+    # Load configuration
+    config = Config.from_yaml_file(Path("config.yaml"))
+
+    # Create ARC object
+    inv = ArcInvestigation.create(identifier="my-arc", title="My ARC")
+    arc = ARC.from_arc_investigation(inv)
+
+    # Use client with context manager
+    async with ApiClient(config) as client:
+        # Send a single ARC
+        response = await client.create_or_update_arc(
+            rdi="my-rdi",
+            arc=arc,
+        )
+        print(f"ARC status: {response.status}")
+
+        # Or run a harvest workflow
+        async def arc_stream():
+            yield arc
+
+        harvest = await client.harvest_arcs(
+            rdi="my-rdi",
+            arcs=arc_stream(),
+            expected_datasets=1,
+        )
+        print(f"Harvest status: {harvest.status}")
+
+
+asyncio.run(main())
+```
+
+## Configuration Options
+
+| Option | Type | Required | Default | Description |
+| ------ | ---- | -------- | ------- | ----------- |
+| `log_level` | string | No | INFO | Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
+| `api_url` | string | Yes | - | Base URL of the Middleware API |
+| `client_cert_path` | string | No | null | Path to client certificate (PEM format) |
+| `client_key_path` | string | No | null | Path to client private key (PEM format) |
+| `ca_cert_path` | string | No | null | Path to CA certificate for server verification |
+| `timeout` | float | No | 30.0 | Request timeout in seconds |
+| `verify_ssl` | bool | No | true | Enable SSL certificate verification |
+| `max_concurrency` | int | No | 10 | Maximum concurrent API requests (also default for `harvest_arcs`) |
+
+## API Methods
+
+### `create_or_update_arc(rdi: str, arc: ARC | dict) -> ArcResult`
+
+Create or update one ARC in the Middleware API.
+
+**Parameters:**
+
+- `rdi` (str): The RDI identifier (e.g., "edaphobase").
+- `arc` (ARC | dict): ARC object from arctrl or pre-serialised RO-Crate dict.
+
+**Returns:**
+
+- `ArcResult`: Contains the result of the operation.
+
+**Raises:**
+
+- `ApiClientError`: If the request fails due to HTTP errors or network issues.
+
+**Example:**
+
+```python
+from arctrl import ARC, ArcInvestigation
+
+inv = ArcInvestigation.create(identifier="my-arc-001", title="My ARC")
+arc = ARC.from_arc_investigation(inv)
+
+response = await client.create_or_update_arc(
+    rdi="edaphobase",
+    arc=arc,
+)
+```
+
+### `harvest_arcs(rdi: str, arcs: AsyncIterator[ARC | dict], expected_datasets: int | None = None) -> HarvestResult`
+
+Convenience workflow to create a harvest, upload all ARCs from an async iterator, and complete the harvest.
+
+- Uses `config.max_concurrency` by default.
+- Continues on item-level submission errors and skips failed items.
+- Cancels the harvest only for catastrophic errors.
+
+All errors are raised as `ApiClientError` exceptions:
+
+```python
+from middleware.api_client import ApiClientError
+
+try:
+    response = await client.create_or_update_arc(
+        rdi="my-rdi",
+        arc=arc,
+    )
+except ApiClientError as e:
+    print(f"API Error: {e}")
+```
+
+## Configuration via Environment Variables
+
+You can override configuration values using environment variables:
+
+```bash
+export API_URL="https://production-api:8000"
+export CLIENT_CERT_PATH="/secure/certs/prod-cert.pem"
+export CLIENT_KEY_PATH="/secure/certs/prod-key.pem"
+```
+
+Or use Docker secrets in `/run/secrets/`.
+
+## License
+
+This is part of the FAIRagro Advanced Middleware project.

fairagro_middleware_api_client-8.6.2/example_client_config.yaml

@@ -0,0 +1,23 @@
+# Example Configuration for Middleware API Client
+
+# Logging level (CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET)
+log_level: INFO
+
+# Base URL of the Middleware API
+api_url: https://localhost:8000
+
+# Path to the client certificate file (PEM format)
+client_cert_path: /path/to/client-cert.pem
+
+# Path to the client private key file (PEM format)
+client_key_path: /path/to/client-key.pem
+
+# Path to the CA certificate file for server verification (optional)
+# Set to null or omit if not needed
+ca_cert_path: /path/to/ca-cert.pem
+
+# Request timeout in seconds
+timeout: "30.0"
+
+# Enable SSL certificate verification
+verify_ssl: true

fairagro_middleware_api_client-8.6.2/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "fairagro-middleware-api-client"
+dynamic = ["version"]
+description = "The FAIRagro advanced middleware API client"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.12.5",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.1.0",
+    "pytest-mock>=3.10.0",
+    "respx>=0.20.0",
+    "cryptography>=45.0.6",
+    "types-pyyaml>=6.0.12.20240917",
+]
+
+[tool.uv.sources]
+shared = { path = "../shared", editable = true }
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --strict-markers --tb=short"
+markers = [
+    "asyncio: marks tests as async (deselect with '-m \"not asyncio\"')",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/middleware"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { root = "../..", fallback_version = "0.0.0", tag_regex = "^(?:v|.*-(?:chart|docker)-v)(?P<version>\\d+\\.\\d+\\.\\d+)(?:$|[-+].*)" }
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"

fairagro_middleware_api_client-8.6.2/src/middleware/api_client/__init__.py

@@ -0,0 +1,18 @@
+"""The FAIRagro Middleware API Client package."""
+
+from .api_client import ApiClient, ApiClientError
+from .config import Config
+from .models import ArcEventSummary, ArcLifecycleStatus, ArcMetadata, ArcResult, ArcStatus, HarvestResult, HarvestStatus
+
+__all__ = [
+    "Config",
+    "ApiClient",
+    "ApiClientError",
+    "ArcResult",
+    "ArcStatus",
+    "ArcLifecycleStatus",
+    "ArcMetadata",
+    "ArcEventSummary",
+    "HarvestResult",
+    "HarvestStatus",
+]