please before working with this repo, change the configs.yaml and use your own username, password and tokens.
there are many ways you can use this repo in order to extract data from jira and use the data for your analytics
- get ticket by its key
from JiraFacade import JiraFacade
ticket = JiraFacade().find_ticket_by_key('SHOP-1234')
print(ticket.get_developed_by())
print(ticket.get_sprint())
print(ticket.get_team_name())
print(ticket.get_status())
print(ticket.get_estimation())
- search tickets
- create a JQL (Jira Query Language) with JQL Builder
from JQLBuilder import JQLBuilder
jql = JQLBuilder()
.set_project('SHOP')
.set_sprints_from_squads(
squad_names=['Discovery', 'OMC'],
sprint='04',
quarter='3')
.get()
- search and get the pandas dataframe
from JiraFacade import JiraFacade
df = JiraFacade().get_df_from_jql(jql, max_results=100)
- build and use custom reports
from DailyVelocityReport import DailyVelocityReport
from DetailedDailyVelocityReport import DetailedDailyVelocityReport
from OutOfPlanReport import OutOfPlanReport
DailyVelocityReport(squads='omc', sprint='04', quarter='3').get()
DetailedDailyVelocityReport(squads='omc', sprint='04', quarter='3').get()
OutOfPlanReport(squads='omc', sprint='04', quarter='3').get()