imednet

Unofficial Python SDK for the iMednet clinical trials API.

Full documentation: https://fderuiter.github.io/imednet-python-sdk/

This package simplifies integration with the iMednet REST API for clinical trial management. It provides typed endpoint wrappers, helper workflows and a CLI so researchers and developers can automate data extraction and submission without reimplementing HTTP logic.

Documentation

Our documentation is organized according to the Diátaxis framework, which categorizes information based on user intent.

📚 Tutorials

Learning-oriented guides for getting started.

• Quick Start
• Async Quick Start
• Examples

🛠️ How-To Guides

Problem-oriented guides for completing specific tasks.

• CLI Usage
• UAT Workflow
• Bulk Submission
• Export Destinations

💡 Explanation

Understanding-oriented concepts and architectural overviews.

• Architecture
• API Overview
• Plugins System

📖 Reference

Information-oriented material like API documentation and contributor rules.

• REST API Reference
• Configuration
• Contributor Rules
• Automated API Reference

Installation

# PyPI release
pip install imednet

For extended integrations, you can install optional dependencies:

pip install "imednet[export]"
pip install imednet-workflows
pip install apache-airflow-providers-imednet

Developer Quickstart & Environment Setup

Contributors and developers can initialize their local environment, credentials, and dependencies using the interactive setup wizard:

bash scripts/wizards/setup-imednet-env.sh

The wizard guides you through:

1. Tooling Verification: Ensuring Python (>= 3.10) and uv are available in your PATH.
2. UTF-8 Encoding: Configuring PYTHONUTF8=1 and PYTHONIOENCODING=utf-8 to prevent Windows console charmap encoding errors.
3. Workspace Synchronization: Running uv sync --extra dev --extra docs to link workspace packages in editable mode.
4. EDC Credentials: Safely entering EDC API credentials into .env (with optional GitHub Actions secrets sync via gh).
5. Self-Test: Validating that the SDK and CLI (imednet --help) are fully operational.

To set up manually:

# Set UTF-8 encoding in PowerShell (Windows) or bash (macOS/Linux)
# PowerShell: $env:PYTHONUTF8 = "1"
# bash: export PYTHONUTF8=1

# Synchronize monorepo packages with dev and docs tooling
uv sync --extra dev --extra docs

Contributing

Contributions are welcome! Please see our Contributor Guide and Verification Loop to get started.

License

This project is licensed under the MIT license. See LICENSE for details.