netrias_client 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

netrias_client/__init__.py

@@ -6,4 +6,4 @@ from ._client import NetriasClient
 
 __all__ = ["NetriasClient", "__version__"]
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"

netrias_client/_client.py

@@ -12,6 +12,8 @@ from dataclasses import replace
 from pathlib import Path
 from uuid import uuid4
 
+from importlib.metadata import PackageNotFoundError, version as package_version
+
 from ._core import harmonize as _harmonize
 from ._core import harmonize_async as _harmonize_async
 from ._discovery import (
@@ -95,6 +97,7 @@ class NetriasClient:
         with self._lock:
             self._settings = settings
             self._logger = logger
+        _emit_configuration_summary(settings=settings, logger=logger)
 
     @property
     def settings(self) -> Settings:
@@ -249,3 +252,29 @@ class NetriasClient:
                 "client not configured; call configure(api_key=...) before use"
             )
         return self._logger
+
+
+def _emit_configuration_summary(*, settings: Settings, logger: logging.Logger) -> None:
+    """Log a sanitized summary of the active client configuration."""
+
+    summary = {
+        "package_version": _resolve_package_version(),
+        "discovery_url": settings.discovery_url,
+        "harmonization_url": settings.harmonization_url,
+        "timeout": settings.timeout,
+        "log_level": settings.log_level.value,
+        "confidence_threshold": settings.confidence_threshold,
+        "discovery_use_gateway_bypass": settings.discovery_use_gateway_bypass,
+        "log_directory": str(settings.log_directory) if settings.log_directory else None,
+    }
+    formatted = ", ".join(f"{key}={value}" for key, value in summary.items() if value is not None)
+    logger.info("client configured: %s", formatted)
+
+
+def _resolve_package_version() -> str:
+    """Return the installed package version or a fallback identifier."""
+
+    try:
+        return package_version("netrias_client")
+    except PackageNotFoundError:
+        return "0.0.0-dev"

netrias_client-0.0.2.dist-info/METADATA

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: netrias_client
+Version: 0.0.2
+Summary: Python client for the Netrias harmonization API
+Project-URL: Homepage, https://github.com/netrias/netrias_client
+Project-URL: Repository, https://github.com/netrias/netrias_client
+Project-URL: Documentation, https://github.com/netrias/netrias_client#readme
+Author-email: Chris Harman <charman@netrias.com>
+License: MIT License
+        
+        Copyright (c) 2025 Netrias
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: api,cde,client,harmonization,netrias
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: boto3
+Requires-Dist: httpx
+Provides-Extra: dev
+Requires-Dist: basedpyright; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: python-dotenv>=1.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.0; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Requires-Dist: ty; extra == 'dev'
+Requires-Dist: typing-extensions; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Netrias Client
+
+"""Explain how to install and exercise the Netrias harmonization client."""
+
+## Install with `uv`
+- Install `uv` once (or update): `curl -LsSf https://astral.sh/uv/install.sh | sh`
+- Sync dependencies for a project that consumes the client:
+  ```bash
+  uv add netrias_client
+  uv add python-dotenv  # optional helper for loading .env files
+  ```
+- Prefer `uv run <command>` for executing scripts so the managed environment is reused automatically.
+
+### Alternative: `pip`
+```bash
+python -m pip install netrias_client
+python -m pip install python-dotenv  # optional
+```
+
+## Quickstart Script
+Reference script (save as `main.py`) showing a full harmonization round-trip:
+
+```python
+#!/usr/bin/env -S uv run python
+# /// script
+# requires-python = ">=3.13"
+# dependencies = ["netrias_client", "python-dotenv"]
+# ///
+
+"""Exercise the packaged Netrias client against the live APIs."""
+
+import asyncio
+import os
+from pathlib import Path
+from typing import Final
+
+from dotenv import load_dotenv
+from netrias_client import NetriasClient
+
+load_dotenv(override=True)
+
+CSV_PATH: Final[Path] = Path("data/primary_diagnosis_1.csv")
+
+
+async def main() -> None:
+    client = NetriasClient()
+    client.configure(api_key=_resolve_api_key())
+
+    manifest = client.discover_cde_mapping(
+        source_csv=CSV_PATH,
+        target_schema="ccdi",
+    )
+
+    _ = await client.harmonize_async(
+        source_path=CSV_PATH,
+        manifest=manifest,
+    )
+
+
+def _resolve_api_key() -> str:
+    api_key = os.getenv("NETRIAS_API_KEY")
+    if api_key:
+        return api_key
+    msg = "Set NETRIAS_API_KEY in your environment or .env file"
+    raise RuntimeError(msg)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Steps
+1. Install or update `uv` (see above).
+2. Export `NETRIAS_API_KEY` (or add it to a local `.env`).
+3. Adjust `CSV_PATH` to point at the source CSV you want to harmonize.
+4. Run `uv run python main.py`.
+
+The client logs its configuration (minus secrets) during `configure(...)` and
+reports harmonization status plus output paths as the workflow progresses, so
+no extra print statements are required.
+
+## `configure()` Options
+`NetriasClient.configure(...)` accepts additional tuning knobs. You can mix and match the ones you need:
+
+| Parameter | Type | Purpose |
+| --- | --- | --- |
+| `api_key` | `str` | **Required.** Bearer token for authenticating with the Netrias services. |
+| `timeout` | `float | None` | Override the default 6-hour timeout for long-running harmonization jobs. |
+| `log_level` | `LogLevel | str | None` | Control verbosity (`INFO` by default). Accepts enum members or string names. |
+| `confidence_threshold` | `float | None` | Minimum score (0–1) for keeping discovery recommendations; lower it to capture more tentative matches. |
+| `discovery_use_gateway_bypass` | `bool | None` | Toggle the temporary AWS Lambda bypass path for discovery (defaults to `True`). Set to `False` once API Gateway limits are sufficient. |
+| `log_directory` | `Path | str | None` | Directory for per-client log files. When omitted, logs stay on stdout. |
+
+Configure only the options you need; unspecified values fall back to sensible defaults.
+
+## Usage Notes
+- `discover_cde_mapping(...)` samples CSV values and returns a manifest-ready payload; use the async variant if you’re already in an event loop.
+- Call `harmonize(...)` (sync) or `harmonize_async(...)` (async) with the manifest to download a harmonized CSV. The result object reports status, description, and the output path.
+- The package exposes `__version__` so callers can assert the installed release.
+- Optional extras (`netrias_client[aws]`) add boto3 helpers for the temporary gateway bypass.

{netrias_client-0.0.1.dist-info → netrias_client-0.0.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
-netrias_client/__init__.py,sha256=bQ0oTDltyN1IbMZxpo_wQlGqiL3yGkGJD5MKez4PbcI,200
+netrias_client/__init__.py,sha256=QpjkueW67jqpgsOf5ExSSdA7ylPWFvSCbuuoCg4wKXE,200
 netrias_client/_adapter.py,sha256=dXJqrpkaAOiZI25gZm0RzFrSFaG4VefvLiM66oI4ziU,9241
-netrias_client/_client.py,sha256=_WVxCOhmCXHG2olDp-eMIKVfHpTt8bibpMQaMRfMSCE,8508
+netrias_client/_client.py,sha256=Si-XJZHQwFjC-PRTsL_e1Nh_U3tV5GyXlf1a95yjKNw,9703
 netrias_client/_config.py,sha256=jY12kLOJ3OMn1YF7QeEq6nU2BaXCpPteoXDz7eprB8I,3098
 netrias_client/_core.py,sha256=f77gwaHfu7lRK2eCSuwumfpU0UXQasZ9D2VVkbPQ68E,18741
 netrias_client/_discovery.py,sha256=YVlA6dGBT4eSUBjyy82aM_Sm_4YK5ulZH_xqk5UJgZk,14380
@@ -12,8 +12,8 @@ netrias_client/_logging.py,sha256=5-lhBgp2hWp2K5ZTzz_ZwhJn_sxhSe_t__kdhuMTJnQ,13
 netrias_client/_models.py,sha256=w_t-rpenLFZiBzLCdRlXaKPqgCrHCjAVoeXjPYF7wIY,1736
 netrias_client/_validators.py,sha256=DvbaQ1Wkf4-W_H5A2PGiC-AxPN2tfpRFpH8vjETGIno,5894
 netrias_client/scripts.py,sha256=jAdREIRbyuSvuvZt6tbRZ9ELfOzQyW9ZQcf2j2HIlsE,11113
-netrias_client-0.0.1.dist-info/METADATA,sha256=5Lx4lh3G_65ThePIeNWWg6W0PHH__8Vg52pJ5hEuMis,9620
-netrias_client-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-netrias_client-0.0.1.dist-info/entry_points.txt,sha256=q7Uj2UATtRzlxefJNziCJQ9RXScH8MQzzWvA86Hfytc,162
-netrias_client-0.0.1.dist-info/licenses/LICENSE,sha256=XzmWyunEynTK9hABeKX_9VEd1WcKSDQAM4IXIS-n8WU,1064
-netrias_client-0.0.1.dist-info/RECORD,,
+netrias_client-0.0.2.dist-info/METADATA,sha256=pJYfxKG5GYVmlSOfjCUCHB3jgvuuXuwpDCUQa2C9TFM,6254
+netrias_client-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+netrias_client-0.0.2.dist-info/entry_points.txt,sha256=q7Uj2UATtRzlxefJNziCJQ9RXScH8MQzzWvA86Hfytc,162
+netrias_client-0.0.2.dist-info/licenses/LICENSE,sha256=XzmWyunEynTK9hABeKX_9VEd1WcKSDQAM4IXIS-n8WU,1064
+netrias_client-0.0.2.dist-info/RECORD,,

netrias_client-0.0.1.dist-info/METADATA

@@ -1,222 +0,0 @@
-Metadata-Version: 2.4
-Name: netrias_client
-Version: 0.0.1
-Summary: Python client for the Netrias harmonization API
-Project-URL: Homepage, https://github.com/netrias/netrias_client
-Project-URL: Repository, https://github.com/netrias/netrias_client
-Project-URL: Documentation, https://github.com/netrias/netrias_client#readme
-Author-email: Chris Harman <charman@netrias.com>
-License: MIT License
-        
-        Copyright (c) 2025 Netrias
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-License-File: LICENSE
-Keywords: api,cde,client,harmonization,netrias
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Requires-Dist: boto3
-Requires-Dist: httpx
-Provides-Extra: dev
-Requires-Dist: basedpyright; extra == 'dev'
-Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
-Requires-Dist: pytest>=7; extra == 'dev'
-Requires-Dist: python-dotenv>=1.0; extra == 'dev'
-Requires-Dist: ruff>=0.5.0; extra == 'dev'
-Requires-Dist: twine>=5.0; extra == 'dev'
-Requires-Dist: ty; extra == 'dev'
-Requires-Dist: typing-extensions; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# Netrias Client
-
-Python toolkit for working with the Netrias recommendation and harmonization services. The client wraps the HTTP APIs with strong typing, logging, and guard rails so analytics code can focus on describing data rather than orchestrating requests.
-
-## Highlights
-- **Stateful client facade** – instantiate `NetriasClient` and call `client.configure(...)` once.
-- **Column discovery helpers** – derive column samples from CSV files, invoke the recommendation service, and normalize responses into `MappingDiscoveryResult` models.
-- **Adapter utilities** – convert discovery output into harmonization-ready manifest payloads while applying confidence filters and CDE overrides.
-- **Asynchronous harmonization loop** – submit jobs, poll for completion, download results, and version output files automatically to avoid accidental overwrites.
-- **Extended timing logs** – discovery and harmonization emit duration metrics so you can spot slow calls quickly during live runs.
-
-## Installation
-
-The project targets Python 3.12+.
-
-```bash
-pip install netrias_client
-
-# optional AWS helpers (gateway bypass)
-pip install netrias_client[aws]
-```
-
-We recommend managing environments with [uv](https://github.com/astral-sh/uv):
-
-```bash
-# create or update a project that depends on netrias_client
-uv add netrias_client
-
-# install optional AWS helpers (gateway bypass)
-uv add netrias_client[aws]
-```
-
-For local development within this repository:
-
-```bash
-uv sync --group dev              # install development tooling
-uv sync --group aws --group dev  # include optional AWS dependencies
-```
-
-## Configuration
-
-All client entry points require explicit configuration. Create a `NetriasClient`, then provide the API key; discovery and harmonization endpoints remain fixed by the library.
-
-```python
-from pathlib import Path
-
-from netrias_client import NetriasClient
-from netrias_client._models import LogLevel
-
-client = NetriasClient()
-client.configure(
-    api_key="<netrias api key>",
-    # Optional overrides:
-    timeout=21600.0,               # seconds (default: 6 hours)
-    log_level=LogLevel.INFO,
-    confidence_threshold=0.80,     # discovery adapter filter, 0.0–1.0
-    discovery_use_gateway_bypass=True,  # toggle Lambda bypass (default: True)
-    log_directory=Path("logs/netrias"),  # optional per-client log files
-)
-```
-
-Configuration errors raise `ClientConfigurationError`. Calling `configure` again replaces the active settings snapshot and reinitializes the dedicated logger (refreshing file handlers when `log_directory` is supplied).
-
-## End-to-End Workflow
-
-The typical harmonization flow contains three steps:
-
-```python
-from pathlib import Path
-
-from netrias_client import NetriasClient
-
-client = NetriasClient()
-client.configure(api_key="<netrias api key>")
-
-csv_path = Path("/path/to/source.csv")
-schema = "ccdi"
-
-# 1. Ask the recommendation service for potential targets.
-manifest_payload = client.discover_mapping_from_csv(
-    source_csv=csv_path,
-    target_schema=schema,
-)
-
-# 2. Kick off harmonization directly with the manifest payload.
-result = client.harmonize(source_path=csv_path, manifest=manifest_payload)
-print(result.status)
-print(result.description)
-print(result.file_path)
-```
-
-- `client.discover_mapping_from_csv(...)` samples up to 25 values per column (configurable), calls the API, and returns a manifest-ready payload (including static metadata such as CDE routes/IDs where configured).
-- `client.harmonize(...)` submits a job and polls `GET /v1/jobs/{jobId}` until the backend returns success or failure. Downloaded CSVs are written next to the source file (versioned as `data.harmonized.v1.csv`, etc.). Pass `manifest_output_path=` if you also want to persist the manifest JSON for inspection.
-
-### Timing Logs
-
-Both discovery and harmonization log elapsed seconds for the full operation and for timeout/transport failures. Sample output:
-
-```
-INFO netrias_client: discover mapping start: schema=ccdi columns=12
-INFO netrias_client: discover mapping complete: schema=ccdi suggestions=0 duration=47.12s
-INFO netrias_client: harmonize start: file=data.csv
-INFO netrias_client: harmonize finished: file=data.csv status=succeeded duration=182.45s
-```
-
-Use these metrics to separate slow API responses from downstream processing overhead.
-
-## Adapter Notes
-
-Discovery results are normalized to manifest payloads automatically; unmatched columns are logged so you can expand coverage. Confidence thresholds come from `configure(confidence_threshold=...)` and default to 0.8.
-
-## Gateway Bypass (Temporary)
-
-The module `netrias_client._gateway_bypass` exposes `invoke_cde_recommendation_alias(...)`, a stopgap helper that calls the `cde-recommendation` Lambda alias directly. This avoids API Gateway’s short timeout window but requires AWS credentials with `lambda:InvokeFunction` permission and the `boto3` dependency.
-
-```python
-from netrias_client._gateway_bypass import invoke_cde_recommendation_alias
-
-result = invoke_cde_recommendation_alias(
-    target_schema="ccdi",
-    columns={"study_name": ["foo", "bar"]},
-    alias="prod",
-    region_name="us-east-2",
-)
-```
-
-Install `boto3` (or `netrias-client[aws]` if provided) before importing the bypass module, and rotate IAM credentials frequently. Once API Gateway limits are raised, prefer the standard discovery flow again.
-
-## Testing & Tooling
-
-The repository ships with pytest-based integration tests plus lint/type tooling.
-
-
-```bash
-uv run pytest
-uv run ruff check
-uv run basedpyright
-uv build                 # produce wheel + sdist
-```
-
-Live verification scripts are located under `live_test/` and require a populated `.env` file containing `NETRIAS_API_KEY` (and optionally harmonization overrides while services converge).
-
-## Project Layout
-
-```
-src/netrias_client/
-    __init__.py          # re-exported public surface
-    _adapter.py          # discovery → manifest conversion
-    _client.py           # NetriasClient facade and state management
-    _config.py           # settings validation helpers
-    _core.py             # harmonization workflow
-    _discovery.py        # discovery wrappers and CSV sampling
-    _errors.py           # exception taxonomy
-    _http.py             # HTTP primitives (submit/poll/download)
-    _io.py               # streaming helpers
-    _logging.py          # standardized logger setup
-    _models.py           # dataclasses for structured responses
-    _validators.py       # filesystem and payload validation
-```
-
-Tests reside under `src/netrias_client/tests/` and are excluded from the published wheel to keep installs slim; run them locally via `uv run pytest`.
-
-## Contributing
-
-1. `uv sync --group dev` (add `--group aws` if needed) to create the virtual environment.
-2. `uv run pytest` to ensure the suite passes prior to committing.
-3. Follow the repo conventions: keep functions focused, prefer typed interfaces, and favor logging key transitions over verbose chatter.
-
-Pull requests should include updated documentation or fixtures when they alter API behavior or the manifest contract.