Load MSAAQ data in Python using dltHub

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

In this guide, we'll set up a complete MSAAQ 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 msaaq_migration_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.msaaq.com/v1/",
            "auth": {
                "type": "bearer",
                "token": access_token,
            },
        },
        "resources": [
            list, Auth, Ping
            ],
    }
    [...]
    yield from rest_api_resources(config)


def get_data() -> None:
    # Connect to destination
    pipeline = dlt.pipeline(
        pipeline_name='msaaq_migration_pipeline',
        destination='duckdb',
        dataset_name='msaaq_migration_data', 
    )
    # Load the data
    load_info = pipeline.run(msaaq_migration_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 msaaq_migration’s API and loads it into Iceberg, DataFrames, files, or a database of your choice. Here are some of the endpoints you can load:

  • User Management: Endpoints related to managing users within the system.
  • Authentication: Endpoints that handle OAuth authentication and token generation.
  • Orders: Endpoints for managing orders and related data.
  • Comments and Reviews: Endpoints for managing user comments and product reviews.

You will then debug the MSAAQ 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 MSAAQ support.

    dlt init dlthub:msaaq_migration 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 MSAAQ API, as specified in @msaaq_migration-docs.yaml 
Start with endpoints list and  and skip incremental loading for now. 
Place the code in msaaq_migration_pipeline.py and name the pipeline msaaq_migration_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 msaaq_migration_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    Authentication requires OAuth2 with bearer tokens. Tokens must be included in the Authorization header for all requests to protected resources. The API requires setup of a connected app in the tenant for successful authentication.

    To get the appropriate API keys, please visit the original source at https://www.msaaq.com/. If you want to protect your environment secrets in a production environment, look into setting up credentials with dlt.

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

    python msaaq_migration_pipeline.py

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

    Pipeline msaaq_migration load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset msaaq_migration_data
The duckdb destination used duckdb:/msaaq_migration.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
    dlt pipeline msaaq_migration_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.

    import dlt

data = dlt.pipeline("msaaq_migration_pipeline").dataset()
# get is table as Pandas frame
data.is.df().head()

Running into errors?

Make sure to comply with the API's rate limits, as exceeding these may result in throttling errors. Also, ensure that all authentication tokens are handled securely and that you possess the necessary permissions for accessing specific endpoints. Some endpoints may return nulls in deeply nested fields, so handle responses accordingly.

Extra resources:

Next steps