Python dlt Guide: Loading Data from Shopify to AWS S3

Connecting other file destinations

This document describes how to set up loading to aws 3, but our filesystem source can not only load to s3, but also to Google Cloud Storage, Google Drive, Azure, or local filesystem. Learn more about this here.

Need help deploying these pipelines, or figuring out how to run them in your data stack?

Join our Slack community or book a call with our support engineer Adrian.

This page provides technical documentation on using the open-source Python library, dlt, to load data from Shopify to AWS S3. Shopify is a comprehensive commerce platform that supports the establishment, growth, management, and scaling of a business. AWS S3, on the other hand, is a remote file system and bucket storage that utilizes fsspec for abstract file operations. It primarily serves as a staging area for other destinations, but can also be utilized to quickly construct a data lake. For more information on Shopify, visit https://www.shopify.com/. This guide will demonstrate how dlt can be leveraged to facilitate the data loading process between these platforms.

dlt Key Features

• Scalable Data Extraction: dlt offers scalable data extraction by leveraging iterators, chunking, and parallelization techniques. This approach allows for efficient processing of large datasets by breaking them down into manageable chunks. More details can be found here.

• Implicit Extraction DAGs: dlt incorporates the concept of implicit extraction DAGs to handle the dependencies between data sources and their transformations automatically. This ensures data consistency and integrity. Learn more about this here.

• Filesystem & buckets: Filesystem destination stores data in remote file systems and bucket storages like S3, Google Storage or Azure Blob Storage. This can be used as a staging for other destinations or to quickly build a data lake. More information is available here.

• Getting Started Guide: dlt provides a detailed getting started guide that walks you through the process of building a pipeline that loads data from the GitHub API into DuckDB. You can find this guide here.

• Understanding How dlt Works: dlt turns JSON returned by any source into a live dataset stored in the destination of your choice. It does this by extracting the JSON data, normalizing it to a schema, and finally loading it to the location where you will store it. More about how dlt works can be found here.

Getting started with your pipeline locally

0. Prerequisites

dlt requires Python 3.8 or higher. Additionally, you need to have the pip package manager installed, and we recommend using a virtual environment to manage your dependencies. You can learn more about preparing your computer for dlt in our installation reference.

1. Install dlt

First you need to install the dlt library with the correct extras for AWS S3:

pip install "dlt[filesystem]"

The dlt cli has a useful command to get you started with any combination of source and destination. For this example, we want to load data from Shopify to AWS S3. You can run the following commands to create a starting point for loading data from Shopify to AWS S3:

# create a new directory
mkdir my-shopify_dlt-pipeline
cd my-shopify_dlt-pipeline
# initialize a new pipeline with your source and destination
dlt init shopify_dlt filesystem
# install the required dependencies
pip install -r requirements.txt

The last command will install the required dependencies for your pipeline. The dependencies are listed in the requirements.txt:

dlt[filesystem]>=0.3.8

You now have the following folder structure in your project:

my-shopify_dlt-pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── shopify_dlt/                   # folder with source specific files
│   └── ...
├── shopify_dlt_pipeline.py        # your main pipeline script
├── requirements.txt         # dependencies for your pipeline
└── .gitignore               # ignore files for git (not required)

2. Configuring your source and destination credentials

The dlt cli will have created a .dlt directory in your project folder. This directory contains a config.toml file and a secrets.toml file that you can use to configure your pipeline:

config.toml

# put your configuration values here

[runtime]
log_level="WARNING"  # the system log level of dlt
# use the dlthub_telemetry setting to enable/disable anonymous usage data reporting, see https://dlthub.com/docs/telemetry
dlthub_telemetry = true

[sources.shopify_dlt]
shop_url = "shop_url" # please set me up!
organization_id = "organization_id" # please set me up!

secrets.toml

# put your secret values and credentials here. do not share this file and do not push it to github

[sources.shopify_dlt]
private_app_password = "private_app_password" # please set me up!
access_token = "access_token" # please set me up!

[destination.filesystem]
bucket_url = "bucket_url" # please set me up!

[destination.filesystem.credentials]
aws_access_key_id = "aws_access_key_id" # please set me up!
aws_secret_access_key = "aws_secret_access_key" # please set me up!

Further help setting up your source and destinations

Please consult the detailed setup instructions for the AWS S3 destination in the dlt destinations documentation.

Likewise you can find the setup instructions for Shopify source in the dlt verifed sources documentation.

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at shopify_dlt_pipeline.py, as well as a folder shopify_dlt that contains additional python files for your source. These files are your local copies which you can modify to fit your needs. In some cases you may find that you only need to do small changes to your pipelines or add some configurations, in other cases these files can serve as a working starting point for your code, but will need to be adjusted to do what you need them to do.

The main pipeline script will look something like this:

"""Pipeline to load shopify data into BigQuery.
"""

import dlt
from dlt.common import pendulum
from typing import List, Tuple
from shopify_dlt import shopify_source, TAnyDateTime, shopify_partner_query


def load_all_resources(resources: List[str], start_date: TAnyDateTime) -> None:
    """Execute a pipeline that will load the given Shopify resources incrementally beginning at the given start date.
    Subsequent runs will load only items updated since the previous run.
    """

    pipeline = dlt.pipeline(
        pipeline_name="shopify", destination='filesystem', dataset_name="shopify_data"
    )
    load_info = pipeline.run(
        shopify_source(start_date=start_date).with_resources(*resources),
    )
    print(load_info)


def incremental_load_with_backloading() -> None:
    """Load past orders from Shopify in chunks of 1 week each using the start_date and end_date parameters.
    This can useful to reduce the potiential failure window when loading large amounts of historic data.
    Chunks and incremental load can also be run in parallel to speed up the initial load.
    """

    pipeline = dlt.pipeline(
        pipeline_name="shopify", destination='filesystem', dataset_name="shopify_data"
    )

    # Load all orders from 2023-01-01 to now
    min_start_date = current_start_date = pendulum.datetime(2023, 1, 1)
    max_end_date = pendulum.now()

    # Create a list of time ranges of 1 week each, we'll use this to load the data in chunks
    ranges: List[Tuple[pendulum.DateTime, pendulum.DateTime]] = []
    while current_start_date < max_end_date:
        end_date = min(current_start_date.add(weeks=1), max_end_date)
        ranges.append((current_start_date, end_date))
        current_start_date = end_date

    # Run the pipeline for each time range created above
    for start_date, end_date in ranges:
        print(f"Load orders between {start_date} and {end_date}")
        # Create the source with start and end date set according to the current time range to filter
        # created_at_min lets us set a cutoff to exclude orders created before the initial date of (2023-01-01)
        # even if they were updated after that date
        data = shopify_source(
            start_date=start_date, end_date=end_date, created_at_min=min_start_date
        ).with_resources("orders")

        load_info = pipeline.run(data)
        print(load_info)

    # Continue loading new data incrementally starting at the end of the last range
    # created_at_min still filters out items created before 2023-01-01
    load_info = pipeline.run(
        shopify_source(
            start_date=max_end_date, created_at_min=min_start_date
        ).with_resources("orders")
    )
    print(load_info)


def load_partner_api_transactions() -> None:
    """Load transactions from the Shopify Partner API.
    The partner API uses GraphQL and this example loads all transactions from the beginning paginated.

    The `shopify_partner_query` resource can be used to run custom GraphQL queries to load paginated data.
    """

    pipeline = dlt.pipeline(
        pipeline_name="shopify_partner",
        destination='filesystem',
        dataset_name="shopify_partner_data",
    )

    # Construct query to load transactions 100 per page, the `$after` variable is used to paginate
    query = """query Transactions($after: String, first: 100) {
        transactions(after: $after) {
            edges {
                cursor
                node {
                    id
                }
            }
        }
    }
    """

    # Configure the resource with the query and json paths to extract the data and pagination cursor
    resource = shopify_partner_query(
        query,
        # JSON path pointing to the data item in the results
        data_items_path="data.transactions.edges[*].node",
        # JSON path pointing to the highest page cursor in the results
        pagination_cursor_path="data.transactions.edges[-1].cursor",
        # The variable name used for pagination
        pagination_variable_name="after",
    )

    load_info = pipeline.run(resource)
    print(load_info)


if __name__ == "__main__":
    # Add your desired resources to the list...
    resources = ["products", "orders", "customers"]
    load_all_resources(resources, start_date="2000-01-01")

    # incremental_load_with_backloading()

    # load_partner_api_transactions()

Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:

python shopify_dlt_pipeline.py

4. Inspecting your load result

You can now inspect the state of your pipeline with the dlt cli:

dlt pipeline shopify info

You can also use streamlit to inspect the contents of your AWS S3 destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline shopify show

5. Next steps to get your pipeline running in production

One of the beauties of dlt is, that we are just a plain Python library, so you can run your pipeline in any environment that supports Python >= 3.8. We have a couple of helpers and guides in our docs to get you there:

The Deploy section will show you how to deploy your pipeline to

• Deploy with Github Actions: dlt can be deployed using Github Actions. This CI/CD runner is essentially free to use. You can specify when the GitHub Action should run using a cron schedule expression. Learn more about this deployment method here.
• Deploy with Airflow: You can also deploy dlt using Airflow. This method involves creating an Airflow DAG for your pipeline script. The DAG uses the dlt Airflow wrapper to simplify the process. Learn more about deploying with Airflow here.
• Deploy with Google Cloud Functions: dlt can be deployed using Google Cloud Functions. This serverless execution environment runs your code in response to events without requiring you to manage the underlying server infrastructure. Learn more about this deployment method here.
• Other Deployment Methods: There are other ways to deploy dlt as well. You can explore these various methods here.

The running in production section will teach you about:

• Monitoring Your Pipeline: With dlt, you can easily monitor your pipeline to ensure it's running smoothly and efficiently. Learn how to monitor your pipeline here.
• Setting Up Alerts: dlt allows you to set up alerts to notify you of any issues or changes in your pipeline. Find out how to set up alerts here.
• Setting Up Tracing: Tracing is another powerful feature of dlt that provides you with detailed information about the execution of your pipeline. Learn how to set up tracing here.

Available Sources and Resources

For this verified source the following sources and resources are available

Source shopify

Shopify is an e-commerce platform offering data on customer accounts, transactions, and product listings.

Resource Name	Write Disposition	Description
customers	merge	Individuals or entities who have created accounts on a Shopify-powered online store
orders	merge	Transactions made by customers on an online store
products	merge	The individual items or goods that are available for sale

Additional pipeline guides

• Load data from MongoDB to Microsoft SQL Server in python with dlt
• Load data from MongoDB to Databricks in python with dlt
• Load data from Pipedrive to MotherDuck in python with dlt
• Load data from Mux to Snowflake in python with dlt
• Load data from Google Analytics to Microsoft SQL Server in python with dlt
• Load data from Airtable to Microsoft SQL Server in python with dlt
• Load data from Slack to Databricks in python with dlt
• Load data from Shopify to Snowflake in python with dlt
• Load data from Stripe to BigQuery in python with dlt
• Load data from Airtable to DuckDB in python with dlt