DIPEX - OS2mo Data Import and Export

5.62.1 verified Fri May 01 auth: no python

DIPEX (OS2mo Data Import and Export) is a tool for importing and exporting organizational data in the OS2mo platform. Version 5.62.1 requires Python >=3.11 and <4.0. Release cadence is irregular, with frequent updates.

pip install dipex

Common errors

error ImportError: cannot import name 'DIPEX' from 'dipex' ↓

cause The main class may not be exposed in the top-level __init__.py; import path changed in recent versions.

fix

Use from dipex import DIPEX if available; otherwise try from dipex.client import DIPEX.

error TypeError: DIPEX.__init__() got an unexpected keyword argument 'base_url' ↓

cause In older versions, the client initialization used different parameter names.

fix

Use api_key only: DIPEX(api_key=...) or check documentation for other parameters.

Warnings

breaking DIPEX 5.x drops support for Python 3.10 and below. Ensure your environment uses Python >=3.11. ↓

fix Upgrade Python to 3.11 or later; use Python 3.10 if you must stay on dipex<5.

deprecated The legacy `dipex.legacy` module is deprecated and will be removed in version 6.0. ↓

fix Migrate to the new API: use `dipex.importer` and `dipex.exporter` instead.

gotcha The `api_key` parameter must be passed as a string; environment variable fallback is not automatic. ↓

fix Explicitly pass the API key: `DIPEX(api_key=os.getenv('DIPEX_API_KEY'))`.

Imports

DIPEX
```
from dipex import DIPEX
```
Main class for data import/export
run_import
```
from dipex.importer import run_import
```
Common import function
run_export
```
from dipex.exporter import run_export
```
Common export function

Quickstart

Initialize DIPEX client and run an import.

from dipex import DIPEX

client = DIPEX(base_url='https://example.com', api_key=os.environ.get('DIPEX_API_KEY', ''))
result = client.run_import('employee_data.csv')
print(result)