Load XWiki data in Python using dltHub

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

In this guide, we'll set up a complete XWiki 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 xwiki_rest_api_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "http://localhost:8080/xwiki/rest/wikis/xwiki/spaces",
            "auth": {
                "type": "basic",
                "username": "Admin",
                "password": "admin",
            },
        },
        "resources": [
            App1/spaces/Doc1/pages/WebHome/objects/App1.Code.App1Class/0/properties, Test/pages/Test/objects
        ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='xwiki_rest_api_pipeline',
        destination='duckdb',
        dataset_name='xwiki_rest_api_data', 
    )
    # Load the data
    load_info = pipeline.run(xwiki_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 xwiki_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:

  • Wikis: Access and manage wiki instances
  • Spaces: Create, retrieve, and organize wiki spaces/sections
  • Pages: Get, create, and modify wiki pages within spaces
  • Objects: Manage objects and their properties attached to pages
  • Properties: Retrieve and update object properties and metadata

You will then debug the XWiki 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:

Now you're ready to get started!

  1. ⚙️ Set up dlt Workspace

    Install dlt with duckdb support:

    pip install dlt[workspace]

    Initialize a dlt pipeline with XWiki support.

    dlt init dlthub:xwiki_rest_api duckdb

    The init command will setup the necessary files and folders for the next step.

  2. 🤠 Start LLM-assisted coding

    Here’s a prompt to get you started:

    Prompt
    Please generate a REST API Source for XWiki API, as specified in @xwiki_rest_api-docs.yaml 
Start with endpoint(s) App1/spaces/Doc1/pages/WebHome/objects/App1.Code.App1Class/0/properties and Test/pages/Test/objects and skip incremental loading for now. 
Place the code in xwiki_rest_api_pipeline.py and name the pipeline xwiki_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 xwiki_rest_api_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    Based on the provided text, the authentication information present is:

Basic authentication is required using username and password credentials passed via the curl -u flag. The credentials should be sent in the Authorization header using Basic auth scheme. In the example, the username is Admin and password is admin. For Python requests, this translates to using the auth parameter with a tuple of username and password, or manually constructing the Authorization header with base64-encoded credentials in the format "Basic base64(username:password)".

To get the appropriate API keys, please visit the original source at forum.xwiki.org.
If you want to protect your environment secrets in a production environment, look into [setting up credentials with dlt](https://dlthub.com/docs/walkthroughs/add_credentials).

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

```shell
python xwiki_rest_api_pipeline.py
```

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

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

5. 📈 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

```shell
dlt pipeline xwiki_rest_api_pipeline show 
```

6. 🐍 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.


```python
import dlt

data = dlt.pipeline("xwiki_rest_api_pipeline").dataset()

get ["App1/spaces/Doc1/pages/WebHome/objects/App1.Code.App1Class/0/properties"] table as Pandas frame

data.["App1/spaces/Doc1/pages/WebHome/objects/App1.Code.App1Class/0/properties"].df().head() ```

Extra resources:

Next steps