Giter Club home page Giter Club logo

sprintr's Introduction

Sprintr

sprintr is a minimal R wrapper of the Jira and Jira Software REST APIs. Convienience functions with object parsing are available for retrieving sprint and velocity information. Bring the power of #rstats to your sprint reporting!

Installation

devtools::install_github("davidski/sprintr")

The following environment variables must be set (typically via .Renviron)

variable purpose
JIRA_API_URL endpoint of the Jira API (ex. https//yourdomain.atlassian.net)
JIRA_USER username (ex. [email protected])
JIRA_API_TOKEN API token as set via id.atlassian.net

Usage

Full docs are coming…

# find the ID of the board of interst
get_boards()

# pull up details on a board
get_board_details(board_id = <x>)

# identify the sprint of interest
get_sprints(board_id = <x>) %>% arrange(desc(endDate))

# get a sprint report
sprint_report <- get_sprint_report(sprint_id = <x>)
# the report has quite a bit of info, for raw story point totals
sprint_report$points_sum

# pull up details on a specific issue
get_issue(issue_key = "XXX-1234")
# or see all the fields on that issue
get_issue("XXX-1234", full_response = TRUE)

# the main personal motivation of this package
sprint_report_detail <- get_sprint_report_detail(sprint_id = <x>)
# do ggplot stuff!

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

The MIT License applies.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.