Sprint Velocity

1.0.5 verified Sat May 09 auth: no python

Generates a Matplotlib plot showing scrum velocity for a sprint using data from Jira. Current version 1.0.5, released occasionally.

pip install sprint-velocity

Common errors

error ModuleNotFoundError: No module named 'sprint_velocity' ↓

cause Package not installed or installed with a different name.

fix

Run 'pip install sprint-velocity' and ensure the package is installed.

error ValueError: Invalid Jira URL ↓

cause JIRA_URL environment variable not set or improperly formatted.

fix

Set JIRA_URL to a valid Jira instance URL, e.g., https://your-domain.atlassian.net.

error jira.exceptions.JIRAError: HTTP 401 Unauthorized ↓

cause Invalid or missing Jira API token or email.

fix

Ensure JIRA_EMAIL and JIRA_API_TOKEN are correct and the token has been generated in Jira.

gotcha Jira API token required; environment variables JIRA_URL, JIRA_EMAIL, JIRA_API_TOKEN must be set, or a .env file present. ↓

fix Set environment variables or create a .env file with the required fields.

gotcha The plot is generated using Matplotlib, which requires a display backend (e.g., TkAgg) on headless systems. ↓

fix Set Matplotlib backend before import (e.g., import matplotlib; matplotlib.use('Agg')) or use a virtual display.

deprecated Config file path argument in older versions was positional; now it's a flag. ↓

fix Use --config flag to specify config file path.

main

wrong

from sprint_velocity import SprintVelocity

correct

from sprint_velocity import main

Module exposes a main() function, not a class.

Run main() after setting environment variables or config file.

from sprint_velocity import main
import os
# Ensure JIRA_URL, JIRA_EMAIL, and JIRA_API_TOKEN are set
main()