Installation¶
Requirements¶
- Python 3.8 or higher
- An active MicroDC API key (starts with
mDC_)
Install from PyPI¶
The distribution is named microdc-client; the import name is microdc.
Not published yet
The first PyPI release is pending. Until then, install from GitLab as shown below.
Install from GitLab¶
Install from Source¶
Install with Development Dependencies¶
This includes pytest, black, ruff, mypy, and other development tools.
Dependencies¶
The library has minimal dependencies:
| Package | Version | Purpose |
|---|---|---|
httpx |
>= 0.27.0 | HTTP client (HTTP/1.1) with connection pooling and async-ready API |
typing-extensions |
>= 4.5.0 | Type hints for Python < 3.10 |
Optional¶
For end-to-end job encryption, install the encryption extra (adds
cryptography >= 41.0.0):
Verify Installation¶
Get an API Key¶
- Sign up at microdc.ai
- Navigate to your account settings
- Generate a new API key
- Your key will look like:
mDC_499FC19C-686A-47C5-AA93-E619C55EBE98
Keep your API key secure
Never commit your API key to version control. Use environment variables or a .microdc.json config file instead.