Loading Data from Pipedrive to Neon Serverless Postgres with dlt in Python

tip

We will be using the dlt PostgreSQL destination to connect to Neon Serverless Postgres. You can get the connection string for your Neon Serverless Postgres database as described in the Neon Serverless Postgres Docs.

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 Violetta.

This page provides technical documentation on loading data from Pipedrive into Neon Serverless Postgres using the open-source Python library dlt. Pipedrive is a business messaging app that connects people to the information they need. Neon Serverless Postgres offers a scalable and reliable platform for building applications faster. This guide will walk you through the process of extracting data from Pipedrive and loading it into Neon Serverless Postgres using dlt. For more information about Pipedrive, visit pipedrive.com.

dlt Key Features

• Pipeline Metadata: dlt pipelines leverage metadata to provide governance capabilities, including load IDs for tracking data loads and facilitating data lineage and traceability. Learn more
• Schema Enforcement and Curation: Ensure data consistency and quality by enforcing and curating schemas, guiding the processing and loading of data. Learn more
• Schema Evolution Alerts: Proactively manage schema changes with alerts that notify users of modifications in the source data’s schema, enabling timely actions. Learn more
• Scaling and Finetuning: Optimize pipeline performance with options for parallel execution, memory buffer adjustments, and intermediary file size configurations. Learn more
• Advanced Transformations: Utilize dbt, SQL client, or Pandas for advanced data transformations to meet specific requirements and ensure data quality. Learn more

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 Neon Serverless Postgres:

pip install "dlt[postgres]"

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 Pipedrive to Neon Serverless Postgres. You can run the following commands to create a starting point for loading data from Pipedrive to Neon Serverless Postgres:

# create a new directory
mkdir pipedrive_pipeline
cd pipedrive_pipeline
# initialize a new pipeline with your source and destination
dlt init pipedrive postgres
# 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[postgres]>=0.3.5

You now have the following folder structure in your project:

pipedrive_pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── pipedrive/                   # folder with source specific files
│   └── ...
├── pipedrive_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. The automatically created version of these files look like this:

generated 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

generated secrets.toml

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

[sources.pipedrive]
pipedrive_api_key = "pipedrive_api_key" # please set me up!

[destination.postgres]
dataset_name = "dataset_name" # please set me up!

[destination.postgres.credentials]
database = "database" # please set me up!
password = "password" # please set me up!
username = "username" # please set me up!
host = "host" # please set me up!
port = 5432
connect_timeout = 15

2.1. Adjust the generated code to your usecase

Further help setting up your source and destinations

• Read more about setting up the Pipedrive source in our docs.
• Read more about setting up the Neon Serverless Postgres destination in our docs.

3. Running your pipeline for the first time

The dlt cli has also created a main pipeline script for you at pipedrive_pipeline.py, as well as a folder pipedrive 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 pipedrive import pipedrive_source


def load_pipedrive() -> None:
    """Constructs a pipeline that will load all pipedrive data"""
    # configure the pipeline with your destination details
    pipeline = dlt.pipeline(
        pipeline_name="pipedrive", destination='postgres', dataset_name="pipedrive_data"
    )
    load_info = pipeline.run(pipedrive_source())
    print(load_info)
    print(pipeline.last_trace.last_normalize_info)


def load_selected_data() -> None:
    """Shows how to load just selected tables using `with_resources`"""
    pipeline = dlt.pipeline(
        pipeline_name="pipedrive", destination='postgres', dataset_name="pipedrive_data"
    )
    # Use with_resources to select which entities to load
    # Note: `custom_fields_mapping` must be included to translate custom field hashes to corresponding names
    load_info = pipeline.run(
        pipedrive_source().with_resources(
            "products", "deals", "deals_participants", "custom_fields_mapping"
        )
    )
    print(load_info)
    # just to show how to access resources within source
    pipedrive_data = pipedrive_source()
    # print source info
    print(pipedrive_data)
    print()
    # list resource names
    print(pipedrive_data.resources.keys())
    print()
    # print `persons` resource info
    print(pipedrive_data.resources["persons"])
    print()
    # alternatively
    print(pipedrive_data.persons)


def load_from_start_date() -> None:
    """Example to incrementally load activities limited to items updated after a given date"""
    pipeline = dlt.pipeline(
        pipeline_name="pipedrive", destination='postgres', dataset_name="pipedrive_data"
    )

    # First source configure to load everything except activities from the beginning
    source = pipedrive_source()
    source.resources["activities"].selected = False

    # Another source configured to activities starting at the given date (custom_fields_mapping is included to translate custom field hashes to names)
    activities_source = pipedrive_source(
        since_timestamp="2023-03-01 00:00:00Z"
    ).with_resources("activities", "custom_fields_mapping")

    # Run the pipeline with both sources
    load_info = pipeline.run([source, activities_source])
    print(load_info)


if __name__ == "__main__":
    # run our main example
    load_pipedrive()
    # load selected tables and display resource info
    # load_selected_data()
    # load activities updated since given date
    # load_from_start_date()

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

python pipedrive_pipeline.py

4. Inspecting your load result

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

dlt pipeline pipedrive info

You can also use streamlit to inspect the contents of your Neon Serverless Postgres destination for this:

# install streamlit
pip install streamlit
# run the streamlit app for your pipeline with the dlt cli:
dlt pipeline pipedrive 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 dlt pipeline using Github Actions.
• Deploy with Airflow: Follow this guide to deploy your dlt pipeline with Airflow and Google Composer.
• Deploy with Google Cloud Functions: Explore the steps to deploy your dlt pipeline using Google Cloud Functions.
• Other Deployment Options: Discover more ways to deploy your dlt pipeline with various services 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. How to Monitor your pipeline
• Set up alerts: Configure alerts to be notified of any issues or important events in your dlt pipeline. Set up alerts
• And set up tracing: Implement tracing to gain insights into the execution and performance of your dlt pipeline. And set up tracing

Available Sources and Resources

For this verified source the following sources and resources are available

Source pipedrive

Pipedrive source provides comprehensive data on sales activities, customer interactions, deals, and user information.

Resource Name	Write Disposition	Description
activities	merge	Refers to scheduled events or tasks associated with deals, contacts, or organizations
custom_fields_mapping	replace	Mapping for custom fields in Pipedrive
deals	merge	Potential sale or transaction that you can track through various stages
deals_flow	merge	Represents the flow of deals in Pipedrive
deals_participants	merge	Represents the participants of deals in Pipedrive
leads	merge	Prospective customers or individuals that have shown interest in a company's products or services
organizations	merge	Company or entity with which you have potential or existing business dealings
persons	merge	Individual contact or lead with whom sales deals can be associated
products	merge	Goods or services that a company sells, which can be associated with deals
users	merge	Individual with a unique login credential who can access and use the platform

Additional pipeline guides

• Load data from Google Analytics to EDB BigAnimal in python with dlt
• Load data from HubSpot to Neon Serverless Postgres in python with dlt
• Load data from Braze to Timescale in python with dlt
• Load data from GitHub to YugabyteDB in python with dlt
• Load data from IBM Db2 to MotherDuck in python with dlt
• Load data from Clubhouse to CockroachDB in python with dlt
• Load data from Klaviyo to Timescale in python with dlt
• Load data from DigitalOcean to Azure Synapse in python with dlt
• Load data from Google Cloud Storage to Azure Cloud Storage in python with dlt
• Load data from Notion to BigQuery in python with dlt