Query Jira Issues and Load Data
Load Jira issues into LlamaIndex using basic auth, OAuth2, or a personal access token.
Why it matters
Effortlessly extract and load Jira issues into your data pipeline. This asset connects to your Jira instance to retrieve specific issues based on your queries, making it easy to integrate project data into other systems.
Outcomes
What it gets done
Connect to Jira using basic auth, OAuth2, or Personal Access Tokens.
Query Jira issues based on custom JQL.
Load retrieved Jira issue data for further processing.
Integrate Jira data into knowledge bases or other applications.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/li-reader-readers-jira | bash Overview
JIRA Reader
A LlamaIndex reader that loads Jira issues by query, supporting basic auth, OAuth2, and personal access token authentication. Use when you need a specific set of Jira issues loaded for search or question-answering, not for writing to Jira.
What it does
The JIRA Reader loads a set of Jira issues into LlamaIndex based on a query string, supporting three separate authentication methods so it works against both cloud and server-hosted Jira instances. basic_auth takes an email, API token, and server URL; oauth takes a cloud ID and API token for OAuth2 against Jira Cloud; and PATauth takes a server URL and API token for a personal access token against a server-hosted instance.
Once authenticated, JiraReader is initialized with the relevant credentials and load_data is called with a JQL-style query string (such as filtering by project) to fetch the matching issues as documents.
When to use - and when NOT to
Use it when you need to pull a specific, queryable set of Jira issues into a LlamaIndex index or query engine - for example scoping to a single project or a filtered subset of tickets. Choose the authentication method that matches your Jira setup: OAuth2 for Jira Cloud apps that need it, basic auth for straightforward cloud access with an API token, or PAT auth for a self-hosted server instance. Do not use it expecting write access - the reader only loads issue data, it does not create or modify Jira issues.
Capabilities
load_data runs a query against Jira and returns matching issues as LlamaIndex Document objects, with three supported authentication modes covering Jira Cloud (basic auth or OAuth2) and server-hosted Jira (personal access token).
How to install
pip install llama-index-readers-jira
Requires Jira credentials matching one of the three supported auth modes - an email and API token, an OAuth2 cloud ID and token, or a server URL and personal access token.
Who it's for
Developers who need a specific set of Jira issues loaded into a LlamaIndex pipeline for search or question-answering, whether their Jira is cloud-hosted or self-hosted.
Source README
JIRA Reader
pip install llama-index-readers-jira
The Jira loader returns a set of issues based on the query provided to the dataloader.
We can follow three methods to initialize the loader-
1- basic_auth -> this takes a dict with the following keysbasic_auth:{ "email": "email", "api_token": "token", "server_url": "server_url" }
2- Oauth2 -> this takes a dict with the following keysoauth:{ "cloud_id": "cloud_id", "api_token": "token" }
3- Personal access Token with Server hosted instancePATauth:{ "server_url": "server_url", "api_token": "token" }
You can follow this link for more information regarding Oauth2 -> https://developer.atlassian.com/cloud/confluence/oauth-2-3lo-apps/
Usage
Here's an example of how to use it
from llama_index.readers.jira import JiraReader
reader = JiraReader(
email=email, api_token=api_token, server_url="your-jira-server.com"
)
documents = reader.load_data(query="project = <your-project>")
Alternately, you can also use download_loader from llama_index
from llama_index.readers.jira import JiraReader
reader = JiraReader(
email=email, api_token=api_token, server_url="your-jira-server.com"
)
documents = reader.load_data(query="project = <your-project>")
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.