Load Open-Xchange data in Python using dltHub

Build a Open-Xchange-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support.

In this guide, we'll set up a complete Open-Xchange data pipeline from API credentials to your first data load in just 10 minutes. You'll end up with a fully declarative Python pipeline based on dlt's REST API connector, like in the partial example code below:

Example code
@dlt.source
def open_xchange_rest_api_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "http://appsuite.example.com/",
            "auth": {
                "type": "bearer",
                "token": access_token,
            },
        },
        "resources": [
            ajax/fileservice, ajax/oauth/accounts
        ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='open_xchange_rest_api_pipeline',
        destination='duckdb',
        dataset_name='open_xchange_rest_api_data', 
    )
    # Load the data
    load_info = pipeline.run(open_xchange_rest_api_source())
    print(load_info)

Why use dltHub Workspace with LLM Context to generate Python pipelines?

Accelerate pipeline development with AI-native context
Debug pipelines, validate schemas and data with the integrated Pipeline Dashboard
Build Python notebooks for end users of your data
Low maintenance thanks to Schema evolution with type inference, resilience and self documenting REST API connectors. A shallow learning curve makes the pipeline easy to extend by any team member
dlt is the tool of choice for Pythonic Iceberg Lakehouses, bringing mature data loading to pythonic Iceberg with or without catalogs

What you’ll do

We’ll show you how to generate a readable and easily maintainable Python script that fetches data from open_xchange_rest_api’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

iTIP Push Mail: POST/DELETE operations for calendar invitation handling via push mail
File Account Management: GET operations to retrieve file service accounts and OAuth configurations
Attachment Operations: GET endpoints for document retrieval, attachment fetching, and update notifications

You will then debug the Open-Xchange pipeline using our Pipeline Dashboard tool to ensure it is copying the data correctly, before building a Notebook to explore your data and build reports.

Setup & steps to follow

💡
Before getting started, let's make sure Cursor is set up correctly:

We suggest using a model like Claude 3.7 Sonnet or better
Index the REST API Source tutorial: https://dlthub.com/docs/dlt-ecosystem/verified-sources/rest_api/ and add it to context as @dlt rest api
Read our full steps on setting up Cursor

Now you're ready to get started!

⚙️ Set up dlt Workspace

Install dlt with duckdb support:
```
pip install dlt[workspace]
```
Initialize a dlt pipeline with Open-Xchange support.
```
dlt init dlthub:open_xchange_rest_api duckdb
```
The init command will setup the necessary files and folders for the next step.

🤠 Start LLM-assisted coding

Here’s a prompt to get you started:

Prompt
Please generate a REST API Source for Open-Xchange API, as specified in @open_xchange_rest_api-docs.yaml 
Start with endpoint(s) ajax/fileservice and ajax/oauth/accounts and skip incremental loading for now. 
Place the code in open_xchange_rest_api_pipeline.py and name the pipeline open_xchange_rest_api_pipeline. 
If the file exists, use it as a starting point. 
Do not add or modify any other files. 
Use @dlt rest api as a tutorial. 
After adding the endpoints, allow the user to run the pipeline with python open_xchange_rest_api_pipeline.py and await further instructions.

🔒 Set up credentials

OAuth 2.0 is supported as an authorization mechanism. The OX App Suite can act as an OAuth 2.0 provider (since v7.8.0) and also supports external authorization servers that issue JSON Web Tokens (JWT) or opaque access tokens. OAuth 2.0 provider functionality is enabled via the com.openexchange.oauth.provider.enabled property, and the provider mode is configured through com.openexchange.oauth.provider.mode. Specific endpoints and required permission scopes for OAuth-protected API calls are documented in the current API documentation. External Identity & Access management systems like Keycloak are supported for token validation.

To get the appropriate API keys, please visit the original source at documentation.open-xchange.com. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

🏃‍♀️ Run the pipeline in the Python terminal in Cursor


python open_xchange_rest_api_pipeline.py

If your pipeline runs correctly, you’ll see something like the following:


Pipeline open_xchange_rest_api load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset open_xchange_rest_api_data
The duckdb destination used duckdb:/open_xchange_rest_api.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

📈 Debug your pipeline and data with the Pipeline Dashboard

Now that you have a running pipeline, you need to make sure it’s correct, so you do not introduce silent failures like misconfigured pagination or incremental loading errors. By launching the dlt Workspace Pipeline Dashboard, you can see various information about the pipeline to enable you to test it. Here you can see:
- Pipeline overview: State, load metrics
- Data’s schema: tables, columns, types, hints
- You can query the data itself
```
dlt pipeline open_xchange_rest_api_pipeline show 
```
🐍 Build a Notebook with data explorations and reports

With the pipeline and data partially validated, you can continue with custom data explorations and reports. To get started, paste the snippet below into a new marimo Notebook and ask your LLM to go from there. Jupyter Notebooks and regular Python scripts are supported as well.
```
import dlt

data = dlt.pipeline("open_xchange_rest_api_pipeline").dataset()
# get ["ajax/fileservice"] table as Pandas frame
data.["ajax/fileservice"].df().head()
```

Extra resources:

Learn more with our 1h LLM-assisted coding course!