Getting Started with Datamint Python API

This guide will help you set up and start using the Datamint Python API for your medical imaging projects.

Installation

Datamint requires Python 3.10+. Install/update Datamint and its dependencies using pip

pip install -U datamint

We recommend that you install Datamint in a dedicated virtualenv, to avoid conflicting with your system packages. You can do this by running:

python3 -m venv datamint-env
source datamint-env/bin/activate # In Windows, run datamint-env\Scripts\activate.bat
pip install -U datamint

Setup API key

To use the Datamint API, you need to setup your API key (ask your administrator if you don’t have one). Use one of the following methods to setup your API key:

Method 1: Command-line tool (recommended)

Run datamint-config in the terminal and follow the instructions. See Command-line tools for more details.

Method 2: Environment variable

Specify the API key as an environment variable.

export DATAMINT_API_KEY="my_api_key"
# run your commands (e.g., `datamint-upload`, `python script.py`)

import os
os.environ["DATAMINT_API_KEY"] = "my_api_key"

Method 3: Api constructor

Specify API key in the Api constructor:

from datamint import Api

api = Api(api_key='my_api_key')

Next Steps

Now that you have the basics set up, explore these advanced topics:

Master the command-line interface: Command-line tools
Check out our Python API documentation: Client Python API
Our Pytorch, Lightning and MLflow integration: PyTorch & Lightning Integration