Loading Data from Jira 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.

Loading data from Jira to Neon Serverless Postgres is made simple with the open-source Python library dlt. Jira is a leading project management tool for agile teams, enabling them to plan, track, and release world-class software. Neon Serverless Postgres offers a serverless platform to build reliable and scalable applications faster. Using dlt, you can efficiently transfer data from Jira to Neon Serverless Postgres, ensuring seamless integration and data consistency. For more information on Jira, visit this link.

dlt Key Features

• Schema Enforcement and Curation: dlt empowers users to enforce and curate schemas, ensuring data consistency and quality. Learn more
• Pipeline Metadata: dlt pipelines leverage metadata to provide governance capabilities, including load IDs for incremental transformations and data lineage. Learn more
• Scaling and Finetuning: dlt offers several mechanisms and configuration options to scale up and finetune pipelines, including parallel execution and memory optimization. Learn more
• Schema Evolution Alerts: dlt notifies users of schema changes, enabling proactive governance and impact analysis. Learn more
• Build a Data Pipeline Tutorial: A step-by-step guide to building a pipeline that loads data from the GitHub API into DuckDB, showcasing dlt's features. Start the tutorial

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

# create a new directory
mkdir jira_pipeline
cd jira_pipeline
# initialize a new pipeline with your source and destination
dlt init jira 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.25

You now have the following folder structure in your project:

jira_pipeline/
├── .dlt/
│   ├── config.toml          # configs for your pipeline
│   └── secrets.toml         # secrets for your pipeline
├── jira/                   # folder with source specific files
│   └── ...
├── jira_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.jira]
subdomain = "subdomain" # please set me up!
email = "email" # please set me up!
api_token = "api_token" # 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 Jira 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 jira_pipeline.py, as well as a folder jira 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:

from typing import List, Optional

import dlt
from jira import jira, jira_search


def load(endpoints: Optional[List[str]] = None) -> None:
    """
    Load data from specified Jira endpoints into a dataset.

    Args:
        endpoints: A list of Jira endpoints. If not provided, defaults to all resources.
    """
    if not endpoints:
        endpoints = list(jira().resources.keys())

    pipeline = dlt.pipeline(
        pipeline_name="jira_pipeline", destination='postgres', dataset_name="jira"
    )

    load_info = pipeline.run(jira().with_resources(*endpoints))

    print(f"Load Information: {load_info}")


def load_query_data(queries: List[str]) -> None:
    """
    Load issues from specified Jira queries into a dataset.

    Args:
        queries: A list of JQL queries.
    """
    pipeline = dlt.pipeline(
        pipeline_name="jira_search_pipeline",
        destination='postgres',
        dataset_name="jira_search",
    )

    load_info = pipeline.run(jira_search().issues(jql_queries=queries))

    print(f"Load Information: {load_info}")


if __name__ == "__main__":
    # Add your desired endpoints to the list 'endpoints'
    load(endpoints=None)

    queries = [
        "created >= -30d order by created DESC",
        'project = KAN AND status = "In Progress" order by created DESC',
    ]

    load_query_data(queries=queries)

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

python jira_pipeline.py

4. Inspecting your load result

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

dlt pipeline jira_pipeline 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 jira_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 dlt pipeline using GitHub Actions for CI/CD automation. Read more
• Deploy with Airflow: Follow the guide to deploy your dlt pipeline with Airflow and Google Composer. Read more
• Deploy with Google Cloud Functions: Discover how to deploy your dlt pipeline using Google Cloud Functions for serverless execution. Read more
• Explore other deployment options: Check out various other methods to deploy your dlt pipeline. Read more

The running in production section will teach you about:

• How to Monitor your pipeline: Learn how to effectively monitor your dlt pipeline to ensure it runs smoothly in production. How to Monitor your pipeline
• Set up alerts: Setting up alerts helps you stay informed about the status of your dlt pipeline. Set up alerts
• Set up tracing: Enable tracing to get detailed insights into the execution of your dlt pipeline. And set up tracing

Available Sources and Resources

For this verified source the following sources and resources are available

Source jira

The Jira source provides data on project management tasks, including details on issues, users, workflows, and projects.

Resource Name	Write Disposition	Description
issues	replace	Individual pieces of work to be completed. Contains various fields such as assignee, comments, created time, reporter, status, summary, updated time, etc.
projects	replace	A collection of tasks that need to be completed to achieve a certain outcome. Contains fields such as avatar URL, description, ID, key, lead, name, etc.
users	replace	Administrator of a given project. Contains fields such as account ID, account type, avatar URL, display name, email address, etc.
workflows	replace	The key aspect of managing and tracking the progress of issues or tasks within a project. Contains fields such as created time, description, ID, updated time, etc.

Additional pipeline guides

• Load data from Oracle Database to Neon Serverless Postgres in python with dlt
• Load data from IBM Db2 to Databricks in python with dlt
• Load data from Google Cloud Storage to Neon Serverless Postgres in python with dlt
• Load data from Jira to Databricks in python with dlt
• Load data from MongoDB to Databricks in python with dlt
• Load data from Stripe to Google Cloud Storage in python with dlt
• Load data from Rest API to ClickHouse in python with dlt
• Load data from PostgreSQL to AWS Athena in python with dlt
• Load data from Salesforce to YugabyteDB in python with dlt
• Load data from HubSpot to Azure Cosmos DB in python with dlt