Skip to main content

Loading Pipedrive Data to Snowflake Using Python and dlt Library

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 for loading data from Pipedrive, a business messaging app that connects people with the information they need, to Snowflake, a cloud-based data warehousing platform for storing, processing, and analyzing large volumes of data. The process is facilitated by an open-source Python library called dlt. For more information about Pipedrive, visit https://pipedrive.com.

dlt Key Features​

  • Automated Maintenance: dlt offers automated maintenance with schema inference and evolution and alerts. This makes maintenance simple and efficient. This feature is explained in detail here.
  • Versatility: dlt can run anywhere Python runs - on Airflow, serverless functions, notebooks. It doesn't require any external APIs, backends or containers, and can scale on micro and large infrastructures alike. Learn more about it here.
  • User-friendly Interface: dlt provides a user-friendly, declarative interface that removes knowledge obstacles for beginners while empowering senior professionals. Get started with dlt here.
  • Support for Multiple Authentication Types: dlt supports password authentication, key pair authentication, and external authentication. This makes it flexible and adaptable to different security requirements. Read more about it here.
  • Robust Governance Support: dlt pipelines offer robust governance support through pipeline metadata utilization, schema enforcement and curation, and schema change alerts. This contributes to better data management practices and overall data governance. Learn more about it 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 Snowflake:

pip install "dlt[snowflake]"

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

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

You now have the following folder structure in your project:

my-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:

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

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.snowflake.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!
warehouse = "warehouse" # please set me up!
role = "role" # please set me up!
Further help setting up your source and destinations

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

Likewise you can find the setup instructions for Pipedrive 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 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='snowflake', dataset_name="pipedrive_data"
    )
    load_info = pipeline.run(pipedrive_source())
    print(load_info)


def load_selected_data() -> None:
    """Shows how to load just selected tables using `with_resources`"""
    pipeline = dlt.pipeline(
        pipeline_name="pipedrive", destination='snowflake', 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='snowflake', 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 Snowflake 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: Github Actions is a CI/CD runner that you can use for free. The dlt command dlt deploy <script>.py github-action --schedule "*/30 * * * *" allows you to specify when the GitHub Action should run using a cron schedule expression. Learn more about how to deploy a pipeline with Github Actions.
  • Deploy with Airflow: Google Composer is a managed Airflow environment provided by Google. The command dlt deploy <script>.py airflow-composer will create an Airflow DAG for your pipeline script. Learn more about how to deploy a pipeline with Airflow.
  • Deploy with Google Cloud Functions: Google Cloud Functions is a serverless execution environment for building and connecting cloud services. With Cloud Functions you can write simple, single-purpose functions that are attached to events emitted from your cloud infrastructure and services. Learn more about how to deploy a pipeline with Google Cloud Functions.
  • Other Deployment Options: There are many other ways to deploy your dlt pipeline. Check out the full list of deployment options here.

The running in production section will teach you about:​

  • Monitor Your Pipeline: dlt provides tools that allow you to monitor your pipeline's performance and status in real-time. This is crucial for identifying and resolving issues promptly. You can learn more about this feature here.
  • Set Up Alerts: dlt allows you to set up alerts that notify you of any changes or problems in your pipeline. This helps you to react quickly to any potential issues. You can find more details on how to set up alerts here.
  • Set Up Tracing: Tracing is a powerful feature in dlt that allows you to track the execution of your pipeline. This is particularly useful for debugging and optimization purposes. You can learn how to set up tracing here.

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 NameWrite DispositionDescription
activitiesmergeRefers to scheduled events or tasks associated with deals, contacts, or organizations
custom_fields_mappingreplaceMapping for custom fields in Pipedrive
dealsmergePotential sale or transaction that you can track through various stages
deals_flowmergeRepresents the flow of deals in Pipedrive
deals_participantsmergeRepresents the participants of deals in Pipedrive
leadsmergeProspective customers or individuals that have shown interest in a company's products or services
organizationsmergeCompany or entity with which you have potential or existing business dealings
personsmergeIndividual contact or lead with whom sales deals can be associated
productsmergeGoods or services that a company sells, which can be associated with deals
usersmergeIndividual with a unique login credential who can access and use the platform

Additional pipeline guides​

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.