netrias_client 0.0.2__tar.gz → 0.0.4__tar.gz

{netrias_client-0.0.2 → netrias_client-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netrias_client
-Version: 0.0.2
+Version: 0.0.4
 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
@@ -56,33 +56,17 @@ Description-Content-Type: text/markdown
 """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
+- Install `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+- Create, activate, and sync virtual environment:
+```
+uv venv
+source .venv/bin/activate
+uv sync
 ```
 
-## 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."""
+"""Use the Netrias to harmonize data via the Netrias API."""
 
-import asyncio
+```
 import os
 from pathlib import Path
 from typing import Final
@@ -90,64 +74,37 @@ 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")
+# Create a Netrias Client and populate it with your API key
+netrias_client = NetriasClient()
+netrias_client.configure(api_key={Insert API key here})
 
+# Point to the csv file to harmonize
+CSV_PATH: Final[Path] = Path("data") / "primary_diagnosis_1.csv"
 
-async def main() -> None:
-    client = NetriasClient()
-    client.configure(api_key=_resolve_api_key())
+# Determine the data -> CDE mapping
+manifest = netrias_client.discover_cde_mapping(source_csv=CSV_PATH, target_schema="ccdi")
 
-    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())
+# Harmonize the data
+result = netrias_client.harmonize(source_path=CSV_PATH, manifest=manifest)
 ```
 
-### 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
+## Configuration 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. |
+| `confidence_threshold` | `float | None` | Minimum score (0.0–1.0) for keeping discovery recommendations; lower it to capture more tentative matches. |
+| `timeout` | `float | None` | Override the default timeout for 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. |
+| `discovery_use_gateway_bypass` | `bool | None` | Toggle the temporary AWS Lambda bypass path for discovery (defaults to `True`). |
 | `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.
+- `discover_cde_mapping(...)` samples CSV values and returns a manifest-ready payload
+- Call `harmonize(...)` 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.4/README.md

@@ -0,0 +1,57 @@
+# Netrias Client
+
+"""Explain how to install and exercise the Netrias harmonization client."""
+
+## Install with `uv`
+- Install `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+- Create, activate, and sync virtual environment:
+```
+uv venv
+source .venv/bin/activate
+uv sync
+```
+
+"""Use the Netrias to harmonize data via the Netrias API."""
+
+```
+import os
+from pathlib import Path
+from typing import Final
+
+from dotenv import load_dotenv
+from netrias_client import NetriasClient
+
+# Create a Netrias Client and populate it with your API key
+netrias_client = NetriasClient()
+netrias_client.configure(api_key={Insert API key here})
+
+# Point to the csv file to harmonize
+CSV_PATH: Final[Path] = Path("data") / "primary_diagnosis_1.csv"
+
+# Determine the data -> CDE mapping
+manifest = netrias_client.discover_cde_mapping(source_csv=CSV_PATH, target_schema="ccdi")
+
+# Harmonize the data
+result = netrias_client.harmonize(source_path=CSV_PATH, manifest=manifest)
+```
+
+
+## Configuration 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. |
+| `confidence_threshold` | `float | None` | Minimum score (0.0–1.0) for keeping discovery recommendations; lower it to capture more tentative matches. |
+| `timeout` | `float | None` | Override the default timeout for harmonization jobs. |
+| `log_level` | `LogLevel | str | None` | Control verbosity (`INFO` by default). Accepts enum members or string names. |
+| `discovery_use_gateway_bypass` | `bool | None` | Toggle the temporary AWS Lambda bypass path for discovery (defaults to `True`). |
+| `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
+- Call `harmonize(...)` 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.2 → netrias_client-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "netrias_client"
-version = "0.0.2"
+version = "0.0.4"
 description = "Python client for the Netrias harmonization API"
 readme = "README.md"
 requires-python = ">=3.10"

{netrias_client-0.0.2 → netrias_client-0.0.4}/src/netrias_client/__init__.py

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

{netrias_client-0.0.2 → netrias_client-0.0.4}/src/netrias_client/_client.py

@@ -190,6 +190,20 @@ class NetriasClient:
             logger=self._require_logger(),
         )
 
+    async def discover_cde_mapping_async(
+        self,
+        source_csv: Path,
+        target_schema: str,
+        sample_limit: int = 25,
+    ) -> ManifestPayload:
+        """Async compatibility alias for :meth:`discover_mapping_from_csv_async`."""
+
+        return await self.discover_mapping_from_csv_async(
+            source_csv=source_csv,
+            target_schema=target_schema,
+            sample_limit=sample_limit,
+        )
+
     def harmonize(
         self,
         source_path: Path,

netrias_client-0.0.2/README.md

@@ -1,100 +0,0 @@
-# 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.