Git Product home page Git Product logo

jira-rest's Introduction

jira-rest.el

An Emacs major mode for interfacing with JIRA's REST API

Update: I no longer use Jira (and haven't for about a year now) so this project should be considered unmaintained.

This project is the result of seeing the state of the original jira.el. Atlassian's JIRA API docs state quite clearly that the REST API unveiled for JIRA 5.0 is the only version that will be receiving development efforts going forward. Unfortunately, jira.el uses the XML RPC. So in the interest of scratching my own itch I started work on this.

Requires JIRA 5.0+ & json.el.

There seem to be several versions of JIRA's API docs floating around, but in my opinion these are the best.

To Install & Run

  1. Place jira-rest.el somewhere on your load-path
  2. Add (require 'jira-rest) to your .emacs/init.el file.
  3. Put .jira-auth-info.el in your home directory, and set the variables for your authentication information & API endpoint URL.
  4. M-x jira-rest-mode

To Do's

High-priority tasks:

  • Add automated tests with ERT
  • Implement issue search
  • Adding/removing/editing comments
  • Modifying issues (as supported by the API)

Obviously implementing functions to consume every possible API endpoint is a to-do, but priority will likely go to those that get the most use.

Caveats

The capabilities of this mode are limited by what is exposed by JIRA's API. Some notable deficiencies include changing issue status and resolving/closing issues. These deficiencies overlap with the XML RPC API, unfortunately. The hope is, however, that these holes will be plugged since this API will be getting future development.

Contributing

If you would like to contribute, please submit pull requests with your changes/additions. As APIs are prone to undocumented changes and breakage, any new code will require test coverage. (This includes myself. I'll be retrofitting the original code soon.)

jira-rest's People

Contributors

mattdeboard avatar

Watchers

Leo D'Angelo avatar James Cloos avatar

Forkers

linecomparison

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.