LlamaIndex Jira Reader

0.6.0 verified Mon Apr 27 auth: no python

A LlamaIndex reader for loading data from Jira issues. Provides tools to fetch issues using JQL queries and convert them into documents for indexing. Current version: 0.6.0, requires Python >=3.10, <4.0. Active development with frequent releases.

pip install llama-index-readers-jira

Common errors

error ModuleNotFoundError: No module named 'llama_index.readers.jira' ↓

cause The library is not installed or the import path is wrong.

fix

Install with pip install llama-index-readers-jira and ensure import path is from llama_index.readers.jira import JiraReader.

error jira.exceptions.JIRAError: JiraError HTTP 401 url: https://your-domain.atlassian.net/rest/api/2/search ↓

cause Invalid or missing authentication credentials (email/token).

fix

Check JIRA_EMAIL and JIRA_API_TOKEN environment variables or pass them to the constructor.

error AttributeError: 'JiraReader' object has no attribute 'load_data' ↓

cause Using an outdated version of the library (pre-0.2.0) where method was named differently.

fix

Upgrade to latest version: pip install --upgrade llama-index-readers-jira. If tied to older version, check docs for load_data alternative.

error TypeError: JiraReader.__init__() got an unexpected keyword argument 'api_token' ↓

cause Using an older version (<0.4.0) that did not support API token auth.

fix

Upgrade to 0.4.0+ and use email+api_token, or downgrade to use username+password.

Warnings

gotcha If you do not set the JIRA_SERVER_URL environment variable or pass it explicitly, the reader defaults to 'https://your-domain.atlassian.net' which may fail if your server is custom. ↓

fix Always provide server_url: either via env var or parameter.

deprecated Older versions used `from llama_index.readers.jira.base import JiraReader`. This path is deprecated; use the top-level package path instead. ↓

fix Use `from llama_index.readers.jira import JiraReader`.

breaking In version 0.6.0, the reader now uses the `jira` library directly instead of `atlassian-python-api`. If you have code that relied on `atlassian` objects, it will break. ↓

fix Update code to handle Jira issue dicts from the `jira` library. Check the reader's output format.

gotcha The `load_data` method returns a list of Document objects, not raw Jira issues. Each Document's text contains issue fields concatenated. ↓

fix To access raw issue data, use the `load_data` return value text parsing, or use the `jira` library directly.

deprecated Authentication via JIRA_USERNAME and JIRA_PASSWORD env vars is deprecated; use JIRA_API_TOKEN instead. ↓

fix Replace with JIRA_EMAIL and JIRA_API_TOKEN.

Imports

JiraReader
wrong
```
from llama_index.readers.jira.base import JiraReader
```
correct
```
from llama_index.readers.jira import JiraReader
```
Direct import from the package's top-level module; using .base was an older pattern that may break in newer versions.

Quickstart

Basic usage: initialize JiraReader with credentials and JQL query to load issues as documents.

import os
from llama_index.readers.jira import JiraReader

# Set environment variables or pass directly
reader = JiraReader(
    email=os.environ.get('JIRA_EMAIL', ''),
    api_token=os.environ.get('JIRA_API_TOKEN', ''),
    server_url=os.environ.get('JIRA_SERVER_URL', '')
)
# Load issues using JQL
documents = reader.load_data(
    query='project = MYPROJ AND status in ("In Progress", "Done")',
    max_results=50
)
print(f"Loaded {len(documents)} documents")