powerjira 0.2.7

A succinct, minimal local jira control plane that can live in your text editor. Interface with tickets fast!

PowerJira

A succinct local jira control plane

Welcome to PowerJira!

Hate how visually noise and clunky the Jira web-app is? Ever wish you could just type the small subset of issue fields you actually care about into an editor and create/find tickets quickly?

Welcome to the party! 🥳

Table of Contents 📖

---

• Welcome
• Get Started
• Usage
• Technologies
• Contribute
• Acknowledgements
• License/Stats/Author

Get Started 🚀

---

To get started, clone this repo and populate the config files per the readme.

Specifically, you need 4 files. These can be named whatever you wish by editing main.py:59.
Below are the requirements of the file with the default (suggested) file names:

• summary - Text file for the issue summary
• description - Text file for the issue description
• agent.yml - Yaml file for user credentials
• config.yml - Yaml file to configure issue creation

The text files simply contain the text you want in the ticket.
As for the yaml files, see the Usage section below.

Set up your editor space the way you like it, and bam! You've dramatically reduced your time spent in the jira web-app, and even possibly absolve the need for it completely!

Usage ⚙

---

With your shell's working directory positioned where the 4 files are present (or if paths have been set accordingly):

Create ticket with config values

./main.py [-r|--raw]

Fetch info from existing ticket

./main.py --fetch=<issue-key> [-r|--raw]

Info

./main.py [-h|--help]

The "raw" option flag (-r, --raw) outputs a formatted dump of the raw api response.

For your own custom use:

from powerjira import fetchIssue, createTicket

For the configuration yaml's: config.yml

project:   <project-key>
priority:  <priority>

epicKey:   # Leave as empty for standalone task or epic
issueType: <type>

reporter:  <reporter-account-id>
assignee:  <assignee-account-id>

agent.yaml

domain:   <host>

userName: <email>
token:    <jira-access-token>

Technologies 🧰

---

• PyYAML
• python-jira
• Poetry

Contribute 🤝

---

Feel free to push PR's to help make this tool more extensible/flexible.

Acknowledgements 💙

---

Thanks to Atlassian for making market-leading tools that kinda frustrate me.

License, Stats, Author 📜

---

See License for the full license text.

This repository was authored by Isaac Yep.
PyPi Package

Back to Table of Contents