Registry / llm-agents / llama-index-readers-jira

llama-index-readers-jira

JSON →
library0.6.0pypypi✓ verified 85d ago

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
INSTALL
IMPORT
SIG · LLAMA-INDEX-READER
L
llama-index-readers-jira
llm-agentspythonv0.6.0
Install
18.7s avg
Import
5684ms
Disk
250MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.6.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.95 runs
installs and imports cleanly · install 0.0s · import 4.728s · 239.8MB
glibc
py 3.103.95 runs
installs and imports cleanly · install 18.7s · import 4.366s · 236MB
250MB installed
● package 250MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

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

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")
Debug
Known issues
gotchaIf 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.
affects: all
deprecatedOlder 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`.
affects: >=0.2.0
breakingIn 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.
affects: 0.6.0
gotchaThe `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.
affects: all
deprecatedAuthentication via JIRA_USERNAME and JIRA_PASSWORD env vars is deprecated; use JIRA_API_TOKEN instead.
fix
Replace with JIRA_EMAIL and JIRA_API_TOKEN.
affects: >=0.4.0
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'llama_index.readers.jira'
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`.
jira.exceptions.JIRAError: JiraError HTTP 401 url: https://your-domain.atlassian.net/rest/api/2/search
Invalid or missing authentication credentials (email/token).
fix
Check JIRA_EMAIL and JIRA_API_TOKEN environment variables or pass them to the constructor.
AttributeError: 'JiraReader' object has no attribute 'load_data'
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.
TypeError: JiraReader.__init__() got an unexpected keyword argument 'api_token'
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.
Upgrade
Version history
0.6.0latest on PyPI · released Mar 12, 2026
Audit
Dependencies
llama-index-corerequiredRequired for base reader classes and document types
jirarequiredPython Jira client for API interaction
Agent activity
32 hits · last 30 days
node
28
OpenAI (training)
1
Resources
llama-index-readers-jira — pip install llama-index-readers-jira · libregistry