Load BaseSpace data in Python using dltHub

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

In this guide, we'll set up a complete BaseSpace 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 basespace_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.basespace.illumina.com/v1pre3/users/current",
            "auth": {
                "type": "bearer",
                "token": access_token,
            }
        },
        "resources": [
            "projects", "trash"
        ],
    }
    [...]
    yield from rest_api_resources(config)


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

  • OAuth Endpoints: Manage authentication and authorization tokens.

    • /v1pre3/oauthv2/token: Obtain an access token.
    • /v1pre3/oauthv2/deviceauthorization: Initiate device authorization flow.

  • Variant Endpoints: Access genetic variant data.

    • /v1pre3/variantset/2150158/variants/chr2?StartPos=1&EndPos=11000&Limit=1: Retrieve variants in a specified range on chromosome 2.

  • Coverage Endpoints: Get coverage metadata for a specific chromosome.

    • /v1pre3/coverage/2150156/chrX/meta: Retrieve coverage metadata for chromosome X.

  • File and Parts Endpoints: Interact with file storage and parts.

    • /v1pre3/files/7094087/parts/1: Access a specific part of a file.
    • /v1pre3/files/7094087?uploadstatus=complete: Get file details based on upload status.

  • Sample Endpoints: Manage sample information.

    • /v1pre3/samples/37037: Retrieve details for a specific sample.

  • User Endpoints: Access user-specific data.

    • /v1pre3/users/current/trash: Access the trash of the current user.
    • /v1pre3/users/current: Retrieve information about the current user.

  • App Session Endpoints: Manage application session properties and results.

    • /v1pre3/appsessions/123/properties/mytestapp.inputs.appresults: Access properties of a specific application session.
    • /v1pre3/appsessions/0480cbb3c56135f3f2265f6437ceadf0: Retrieve a specific application session.

  • Project Endpoints: Access project information.

    • /v1pre3/projects/123: Retrieve details for a specific project.

  • App Results Endpoints: Access results from applications.

    • /v1pre3/appresults/100: Retrieve application results for a specific identifier.

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

    dlt init dlthub:basespace 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 BaseSpace API, as specified in @basespace-docs.yaml 
Start with endpoints projects and trash and skip incremental loading for now. 
Place the code in basespace_pipeline.py and name the pipeline basespace_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 basespace_pipeline.py and await further instructions.

  3. 🔒 Set up credentials

    An API key is required, with the name 'x-access-token' to be included in the header; for OAuth2 authentication, a token is required, and the token URL is http://login.illumina.com, with the flow being application.

    To get the appropriate API keys, please visit the original source at https://developer.basespace.illumina.com/docs/content/documentation/rest-api/api-reference. 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 basespace_pipeline.py

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

    Pipeline basespace load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset basespace_data
The duckdb destination used duckdb:/basespace.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 basespace_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("basespace_pipeline").dataset()
# get "projects" table as Pandas frame
data."projects".df().head()

Extra resources:

Next steps