| Name | netrias_client JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Python client for the Netrias harmonization API |
| upload_time | 2025-10-07 16:26:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| 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. |
| keywords |
api
cde
client
harmonization
netrias
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "netrias_client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, cde, client, harmonization, netrias",
"author": null,
"author_email": "Chris Harman <charman@netrias.com>",
"download_url": "https://files.pythonhosted.org/packages/4e/4e/ca62d53ab2a6c210769758019c01424882f27ca01cc38eb39a4fcf8d0b77/netrias_client-0.0.4.tar.gz",
"platform": null,
"description": "# Netrias Client\n\n\"\"\"Explain how to install and exercise the Netrias harmonization client.\"\"\"\n\n## Install with `uv`\n- Install `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh`\n- Create, activate, and sync virtual environment:\n```\nuv venv\nsource .venv/bin/activate\nuv sync\n```\n\n\"\"\"Use the Netrias to harmonize data via the Netrias API.\"\"\"\n\n```\nimport os\nfrom pathlib import Path\nfrom typing import Final\n\nfrom dotenv import load_dotenv\nfrom netrias_client import NetriasClient\n\n# Create a Netrias Client and populate it with your API key\nnetrias_client = NetriasClient()\nnetrias_client.configure(api_key={Insert API key here})\n\n# Point to the csv file to harmonize\nCSV_PATH: Final[Path] = Path(\"data\") / \"primary_diagnosis_1.csv\"\n\n# Determine the data -> CDE mapping\nmanifest = netrias_client.discover_cde_mapping(source_csv=CSV_PATH, target_schema=\"ccdi\")\n\n# Harmonize the data\nresult = netrias_client.harmonize(source_path=CSV_PATH, manifest=manifest)\n```\n\n\n## Configuration Options\n`NetriasClient.configure(...)` accepts additional tuning knobs. You can mix and match the ones you need:\n\n| Parameter | Type | Purpose |\n| --- | --- | --- |\n| `api_key` | `str` | **Required.** Bearer token for authenticating with the Netrias services. |\n| `confidence_threshold` | `float | None` | Minimum score (0.0\u20131.0) for keeping discovery recommendations; lower it to capture more tentative matches. |\n| `timeout` | `float | None` | Override the default timeout for harmonization jobs. |\n| `log_level` | `LogLevel | str | None` | Control verbosity (`INFO` by default). Accepts enum members or string names. |\n| `discovery_use_gateway_bypass` | `bool | None` | Toggle the temporary AWS Lambda bypass path for discovery (defaults to `True`). |\n| `log_directory` | `Path | str | None` | Directory for per-client log files. When omitted, logs stay on stdout. |\n\nConfigure only the options you need; unspecified values fall back to sensible defaults.\n\n## Usage Notes\n- `discover_cde_mapping(...)` samples CSV values and returns a manifest-ready payload\n- Call `harmonize(...)` or `harmonize_async(...)` (async) with the manifest to download a harmonized CSV. The result object reports status, description, and the output path.\n- The package exposes `__version__` so callers can assert the installed release.\n- Optional extras (`netrias_client[aws]`) add boto3 helpers for the temporary gateway bypass.\n",
"bugtrack_url": null,
"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.",
"summary": "Python client for the Netrias harmonization API",
"version": "0.0.4",
"project_urls": {
"Documentation": "https://github.com/netrias/netrias_client#readme",
"Homepage": "https://github.com/netrias/netrias_client",
"Repository": "https://github.com/netrias/netrias_client"
},
"split_keywords": [
"api",
" cde",
" client",
" harmonization",
" netrias"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1549196d5ea6b038db1bf15fe8720f91bc5d623f53120679dab9b99e665b44b6",
"md5": "5a25c5b6f57aa3325b14c2f33608444f",
"sha256": "5b21ad8fe206033da4868bf1b17a3216b454321c77a19b87876565dc4a679353"
},
"downloads": -1,
"filename": "netrias_client-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a25c5b6f57aa3325b14c2f33608444f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31323,
"upload_time": "2025-10-07T16:26:14",
"upload_time_iso_8601": "2025-10-07T16:26:14.590896Z",
"url": "https://files.pythonhosted.org/packages/15/49/196d5ea6b038db1bf15fe8720f91bc5d623f53120679dab9b99e665b44b6/netrias_client-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4e4eca62d53ab2a6c210769758019c01424882f27ca01cc38eb39a4fcf8d0b77",
"md5": "5e4d1f01a9abe89073683752fccd42f1",
"sha256": "7b8a4db707d007c19c1c8c952182105a440dcfdcdc6ddde9d2180e6e9852244b"
},
"downloads": -1,
"filename": "netrias_client-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5e4d1f01a9abe89073683752fccd42f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 25508,
"upload_time": "2025-10-07T16:26:15",
"upload_time_iso_8601": "2025-10-07T16:26:15.808473Z",
"url": "https://files.pythonhosted.org/packages/4e/4e/ca62d53ab2a6c210769758019c01424882f27ca01cc38eb39a4fcf8d0b77/netrias_client-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-07 16:26:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "netrias",
"github_project": "netrias_client#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netrias_client"
}
