Giter VIP home page Giter VIP logo

jira-report-to-gsheet's Introduction

JIRA Report Generator

This Python script is designed to query JIRA issues and export the details to a Google Sheet.

Description

The script uses the JIRA Python Library to connect to a JIRA instance and retrieve issue data based on a specified JQL (JIRA Query Language) query. The results are then formatted and exported to a specified Google Sheet, allowing for easy viewing and analysis of the data.

Configuration

The report can be configured by creating a json configuration file that contains a few fields:

{                                                                                 
    'fields': "List of Jira Properties"
    'google_sheet': "Name of Google Sheet Document",
    'google_sheet_name': "Name of the sheet where to import data",
    'jql': "The Jira request that will return the list of issues"
}

Jira issues properties

At this time this script imports the following information for each Jira issues part of the JQL results:

  • IssueType : Bug, Task, Story, ...
  • Key : The Jira unique ID (FR-123)
  • FixVersions
  • Assignee
  • Epic : The Epic ID
  • Summary
  • Priority
  • Status
  • Created : date isue was created
  • Resolution
  • Resolved : date issue was resolved
  • Components : the list of impacted components
  • Sprint : the last sprints this issue was part of
  • StoryPoints

Each of this field will be imported in the targeted Google Sheet where each Field will be a column and one line per Jira issue

Getting Started

Dependencies

  • Python 3.x
  • JIRA Python Library
  • gspread (for Google Sheets integration)
  • OAuth credentials for Google Sheets API

Installing

  1. Clone the repository:

    git clone https://github.com/mclemenceau/jira-report-to-gsheet
  2. Navigate to the project directory:

    cd jira-report-to-gsheet
  3. Install the required Python packages:

    pip install -r requirements.txt

Configuration

  1. Create a config.json file with your JIRA and Google Sheets configuration.

    • See example in example in the config directory
  2. Obtain OAuth credentials from Google Developers Console for Google Sheets API and save them in the project directory.

Usage

Run the script with the following command:

jira-report-to-gsheet -c path_to_config.json

Running the script without argument would look for config.json in the current folder

jira-report-to-gsheet's People

Contributors

mclemenceau avatar

Watchers

 avatar

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.