Metadata-Version: 2.3
Name: notedx-sdk
Version: 0.1.10
Summary: Official Python SDK for the NoteDx API - a powerful medical note generation service, fully compliant to healthcare regulations in the US and Canada.
License: Proprietary
Keywords: medical,notes,transcription,healthcare,api,AI,scribe,AI-scribe,pharmacy,nursing,radiology,procedures,medicalSpecialties,HIPAA,PIPEDA,Canada,USA,Quebec
Author: Julien Martel
Requires-Python: >=3.8.2,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Healthcare Industry
Classifier: License :: Other/Proprietary License
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
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: requests (>=2.31.0,<3.0.0)
Project-URL: Documentation, https://martelman.github.io/NoteDx-API-Client/
Project-URL: Homepage, https://www.notedxai.com/contact-8-1
Project-URL: Repository, https://github.com/martelman/NoteDx-API-Client
Description-Content-Type: text/markdown

[![Tests](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml/badge.svg)](https://github.com/martelman/NoteDx-API-Client/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/martelman/NoteDx-API-Client/graph/badge.svg?token=O64HJ8B0BF)](https://codecov.io/gh/martelman/NoteDx-API-Client)
![PyPI](https://img.shields.io/pypi/v/notedx-sdk)
![Last Commit](https://img.shields.io/github/last-commit/martelman/NoteDx-API-Client)
![PyPI - Downloads](https://img.shields.io/pypi/dm/notedx-sdk)


# NoteDx API Python Client

Official Python SDK for the NoteDx API - a powerful medical note generation service that converts audio recordings into structured medical notes, fully compliant with data privay laws in Canada and the US.

API console, click [here](https://notedx-api.web.app/auth/login)

## Features

- Audio to medical note conversion
- Support for multiple languages (English, French)
- Multiple medical note templates
- Real-time job status tracking
- Webhook integration
- Usage monitoring
- HIPAA and PIPEDA compliant

## Installation

```bash
pip install notedx-sdk
```

## Quick Start

```python
from notedx_sdk import NoteDxClient

# Initialize client
client = NoteDxClient(api_key="your-api-key")

# Process audio file
response = client.notes.process_audio(
    file_path="visit.mp3",
    visit_type="initialEncounter",
    recording_type="dictation",
    template="primaryCare",
    lang="en",
    documentation_style="problemBased",
    output_language="fr",
    custom={
        "context": "Patient is 30 years old, male, with a history of hypertension and diabetes.",
        "template": "A custom template for your use case"
    },
    custom_metadata={
        "custom_metadata": "Some custom metadata for your use case"
    }
)

# Get job ID
job_id = response["job_id"]

# Check status - ( Or better, use the webhook implementation )
status = client.notes.fetch_status(job_id)

# Get note when ready
if status["status"] == "completed":
    note = client.notes.fetch_note(job_id)
```

## Supported Audio Formats

- MP3 (.mp3)
- MP4/M4A (.mp4, .m4a)
- AAC (.aac)
- WAV (.wav)
- FLAC (.flac)
- PCM (.pcm)
- OGG (.ogg)
- Opus (.opus)
- WebM (.webm)

## Development

```bash
# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies
poetry install

# Run tests
poetry run pytest
```

## Documentation

For complete documentation, visit [NoteDx API Documentation](https://martelman.github.io/NoteDx-API-Client/).

## License

Copyright © 2025 Technologies Medicales JLA Shiftpal inc. All rights reserved.
