https://github.com/coddingtonbear/jirafs

Edit your Jira tickets using locally-stored text files in a git/hg-inspired way
https://github.com/coddingtonbear/jirafs

git jira jira-client python python3

Last synced: 1 day ago
JSON representation

Edit your Jira tickets using locally-stored text files in a git/hg-inspired way

• Host: GitHub
• URL: https://github.com/coddingtonbear/jirafs
• Owner: coddingtonbear
• License: mit
• Created: 2014-07-07T21:54:20.000Z (about 10 years ago)
• Default Branch: development
• Last Pushed: 2024-01-12T02:16:00.000Z (9 months ago)
• Last Synced: 2024-09-26T14:18:46.556Z (7 days ago)
• Topics: git, jira, jira-client, python, python3
• Language: Python
• Homepage:
• Size: 598 KB
• Stars: 134
• Watchers: 6
• Forks: 19
• Open Issues: 3
• Metadata Files:
  • Readme: readme.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Jirafs

======

.. image:: https://travis-ci.org/coddingtonbear/jirafs.svg?branch=master

    :target: https://travis-ci.org/coddingtonbear/jirafs

.. image:: https://badge.fury.io/py/jirafs.png

    :target: http://badge.fury.io/py/jirafs

Pronounced like 'giraffes', but totally unrelated to wildlife, this

library lets you stay out of Jira as much as possible by letting

you edit your Jira issues as a collection of text files using an

interface inspired by ``git`` and ``hg``.

.. image:: http://coddingtonbear-public.s3.amazonaws.com/github/jirafs/readme_demo_2.1_v7.gif

Read more details in `the docs `_.

Plugins and Macros Too

----------------------

Jirafs provides a Plugin API allowing you to simplify your workflow in Jira;

several plugins already exist, including the following tools:

* For including programmatically-generated images in your Jira issues without

  ever leaving your editor:

  * `jirafs-graphviz `_:

    Embed Graphviz (e.g. ``dot`` or ``neato``) graphs using Graphviz's

    ubiquitous graph description language.

  * `jirafs-matplotlib `_:

    Embed graphs generated with the common Python charting library Matplotlib

    by writing simple python scripts.

  * `jirafs-plantuml `_:

    Embed UML (e.g. timing, sequence, or activity) diagrams

    generated via PlantUML's easy-to-use text format.

  * `jirafs-mermaid `_:

    Embed beautiful diagrams (e.g. pie, gantt, or class)

    using Mermaid's markdown-ish diagram description language.

* For making tables more easily:

  * `jirafs-csv-table `_:

    Include tables in Jira by generating them from local CSV files.

  * `jirafs-list-table `_:

    Create tables in Jira by using a simple list-based syntax.

Requirements

------------

* ``git >= 1.8``

* ``python3 >= 3.6``

----------

- Documentation for Jirafs is available on

  `ReadTheDocs `_.

- Please post issues on

  `Github `_.

- Test status available on

  `Travis-CI `_.

- Questions? Ask them on

  `Gitter `_.