Loading Klarna Data to AWS S3 with dlt
in Python
Join our Slack community or book a call with our support engineer Violetta.
klarna
is a global payment solutions provider offering seamless online payment services for businesses and consumers. klarna
provides tools for payment processing, including 'buy now, pay later' options, installment plans, and direct payments. With klarna
, businesses can offer flexible payment solutions, improve customer satisfaction, and increase conversion rates. This documentation will guide you on how to load data from klarna
to aws s3
using the open-source Python library dlt
. The aws s3
destination stores data on aws s3
, allowing you to easily create data lakes. You can upload data in various formats such as JSONL, Parquet, or CSV. For more information about klarna
, visit here.
dlt
Key Features
- AWS Athena / Glue Catalog: The Athena destination stores data as parquet files in S3 buckets and creates external tables in AWS Athena. You can then query those tables with Athena SQL commands which will then scan the whole folder of parquet files and return the results. This destination works very similar to other SQL-based destinations, with the exception of the merge write disposition not being supported at this time. Read more.
- Amazon Kinesis: Amazon Kinesis is a cloud-based service for real-time data streaming and analytics, enabling the processing and analysis of large streams of data in real time. Our AWS Kinesis verified source loads messages from Kinesis streams to your preferred destination. Read more.
- Provider key formats: Providers may use different formats for the keys.
dlt
will translate the standard format where sections and key names are separated by "." into the provider-specific formats. Example: Whendlt
evaluates the requestdlt.secrets["my_section.gcp_credentials"]
it must find theprivate_key
for Google credentials. Read more. - Setup AWS S3 bucket storage and credentials: You need to create an S3 bucket and a user who can access that bucket.
dlt
is not creating buckets automatically. Read more. - Initialize the verified source: To get started with your data pipeline, follow these steps: Enter the following command:
dlt init filesystem duckdb
. This command will initialize the pipeline example with filesystem as the source and duckdb as the destination. Read more.
Getting started with your pipeline locally
dlt-init-openapi
0. Prerequisites
dlt
and dlt-init-openapi
requires Python 3.9 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 and dlt-init-openapi
First you need to install the dlt-init-openapi
cli tool.
pip install dlt-init-openapi
The dlt-init-openapi
cli is a powerful generator which you can use to turn any OpenAPI spec into a dlt
source to ingest data from that api. The quality of the generator source is dependent on how well the API is designed and how accurate the OpenAPI spec you are using is. You may need to make tweaks to the generated code, you can learn more about this here.
# generate pipeline
# NOTE: add_limit adds a global limit, you can remove this later
# NOTE: you will need to select which endpoints to render, you
# can just hit Enter and all will be rendered.
dlt-init-openapi klarna --url https://raw.githubusercontent.com/dlt-hub/openapi-specs/main/open_api_specs/Business/klarna.yaml --global-limit 2
cd klarna_pipeline
# install generated requirements
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>=0.4.12
You now have the following folder structure in your project:
klarna_pipeline/
├── .dlt/
│ ├── config.toml # configs for your pipeline
│ └── secrets.toml # secrets for your pipeline
├── rest_api/ # The rest api verified source
│ └── ...
├── klarna/
│ └── __init__.py # TODO: possibly tweak this file
├── klarna_pipeline.py # your main pipeline script
├── requirements.txt # dependencies for your pipeline
└── .gitignore # ignore files for git (not required)
1.1. Tweak klarna/__init__.py
This file contains the generated configuration of your rest_api. You can continue with the next steps and leave it as is, but you might want to come back here and make adjustments if you need your rest_api
source set up in a different way. The generated file for the klarna source will look like this:
Click to view full file (39 lines)
from typing import List
import dlt
from dlt.extract.source import DltResource
from rest_api import rest_api_source
from rest_api.typing import RESTAPIConfig
@dlt.source(name="klarna_source", max_table_nesting=2)
def klarna_source(
base_url: str = dlt.config.value,
) -> List[DltResource]:
# source configuration
source_config: RESTAPIConfig = {
"client": {
"base_url": base_url,
},
"resources":
[
# Use this API call to get a Klarna Payments session. You can read the Klarna Payments session at any time after it has been created, to get information about it. This will return all data that has been collected during the session. Read more on **[Read an existing payment session](https://docs.klarna.com/klarna-payments/other-actions/check-the-details-of-a-payment-session/)**.
{
"name": "session_read",
"table_name": "session_read",
"endpoint": {
"data_selector": "$",
"path": "/payments/v1/sessions/{session_id}",
"params": {
"session_id": "FILL_ME_IN", # TODO: fill in required path parameter
},
"paginator": "auto",
}
},
]
}
return rest_api_source(source_config)
2. Configuring your source and destination credentials
dlt-init-openapi
will try to detect which authentication mechanism (if any) is used by the API in question and add a placeholder in your secrets.toml
.
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. The automatically created version of these files look like this:
generated config.toml
[runtime]
log_level="INFO"
[sources.klarna]
# Base URL for the API
base_url = "https://api.klarna.com"
generated secrets.toml
[sources.klarna]
# secrets for your klarna source
# example_api_key = "example value"
2.1. Adjust the generated code to your usecase
At this time, the dlt-init-openapi
cli tool will always create pipelines that load to a local duckdb
instance. Switching to a different destination is trivial, all you need to do is change the destination
parameter in klarna_pipeline.py
to filesystem and supply the credentials as outlined in the destination doc linked below.
By default, the filesystem destination will store your files as JSONL
. You can tell your pipeline to choose a different format with the loader_file_format
property that you can set directly on the pipeline or via your config.toml
. Available values are jsonl
, parquet
and csv
:
[pipeline] # in ./dlt/config.toml
loader_file_format="parquet"
3. Running your pipeline for the first time
The dlt
cli has also created a main pipeline script for you at klarna_pipeline.py
, as well as a folder klarna
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:
import dlt
from klarna import klarna_source
if __name__ == "__main__":
pipeline = dlt.pipeline(
pipeline_name="klarna_pipeline",
destination='duckdb',
dataset_name="klarna_data",
progress="log",
export_schema_path="schemas/export"
)
source = klarna_source()
info = pipeline.run(source)
print(info)
Provided you have set up your credentials, you can run your pipeline like a regular python script with the following command:
python klarna_pipeline.py
4. Inspecting your load result
You can now inspect the state of your pipeline with the dlt
cli:
dlt pipeline klarna_pipeline 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 klarna_pipeline 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: Learn how to deploy your pipeline using GitHub Actions, a CI/CD runner that you can use for free. Follow the guide here.
- Deploy with Airflow and Google Composer: Discover how to deploy a pipeline with Airflow and Google Composer, a managed Airflow environment provided by Google. Check out the instructions here.
- Deploy with Google Cloud Functions: Explore the steps to deploy your pipeline using Google Cloud Functions. Find the detailed guide here.
- Other Deployment Options: There are various other ways to deploy your pipeline. Learn more about them here.
The running in production section will teach you about:
- How to Monitor your pipeline: Learn how to effectively monitor your
dlt
pipeline in production to ensure it runs smoothly and efficiently. How to Monitor your pipeline - Set up alerts: Set up alerts to get notified of any issues or important events in your
dlt
pipeline, helping you to promptly address any problems. Set up alerts - Set up tracing: Implement tracing to track the flow of data through your
dlt
pipeline, allowing for better debugging and performance optimization. And set up tracing
Available Sources and Resources
For this verified source the following sources and resources are available
Source Klarna
Klarna source for accessing session data and related analytics.
Resource Name | Write Disposition | Description |
---|---|---|
session_read | append | Session data including user interactions and payment sessions |
Additional pipeline guides
- Load data from Salesforce to DuckDB in python with dlt
- Load data from Google Cloud Storage to MotherDuck in python with dlt
- Load data from GitLab to EDB BigAnimal in python with dlt
- Load data from Coinbase to Google Cloud Storage in python with dlt
- Load data from GitHub to MotherDuck in python with dlt
- Load data from Trello to Azure Cosmos DB in python with dlt
- Load data from Google Sheets to Redshift in python with dlt
- Load data from Azure Cloud Storage to Supabase in python with dlt
- Load data from Keap to ClickHouse in python with dlt
- Load data from Mux to DuckDB in python with dlt