# **PowerJira**
*A succinct local jira control plane.*
<br />
## **Welcome to PowerJira!**
Hate how visually noise and clunky the Jira web-app is? Ever wish you could manage your jira account with a minimalistic interface?
Welcome to the party! 🥳
<br />
### **Table of Contents** 📖
<hr>
- [Welcome](#welcome-to-powerjira)
- [**Get Started**](#get-started-)
- [Usage](#usage-)
- [Technologies](#technologies-)
- [Contribute](#Contribute-)
- [Acknowledgements](#acknowledgements-)
- [License/Stats/Author](#license-stats-author-)
<br />
## **Get Started 🚀**
<hr>
```sh
pip install powerjira
pip install --upgrade powerjira
```
<br />
## **Usage ⚙**
<hr>
Set an alias in your shell environment to open up an editor workspace you want to use powerjira in. \
Then set another alias to run a script like:
```python
# pip install powerjira
# pip install --upgrade powerjira
from powerjira import powerjira
from sys import argv, exit
config_path = 'config.yml'
agent_path = 'agent.yml'
summary_path = 'summary.txt'
description_path = 'description.txt'
powerjira(
config_path,
agent_path,
summary_path,
description_path,
argv[1:]
)
exit(0)
```
Make your local config files:
```sh
touch summary.txt description.txt config.yml agent.yml
```
For the configuration files:
**config.yml**
```yaml
project : <project-key>
priority : <priority>
issue_type : <type>
epicKey : # Leave as empty for standalone task or epic
reporter : <reporter-account-id>
assignee : <assignee-account-id>
```
**agent.yml**
```yaml
domain: <host>
user_name: <email>
token: <jira-access-token>
```
Presuming you've named said shell alias `pj`, print the help message:
```sh
pj --help
```
<br />
## **Technologies 🧰**
<hr>
- [PyYAML](https://pypi.org/project/PyYAML/)
- [python-jira](https://pypi.org/project/jira/)
- [Poetry](https://python-poetry.org/)
- [Typer](https://typer.tiangolo.com/)
<br />
## **Contribute 🤝**
<hr>
Feel free to push PR's to help make this tool more extensible/flexible.
<br />
## **Acknowledgements 💙**
<hr>
Thanks to Atlassian for making market-leading tools that kinda frustrate me.
<br />
## **License, Stats, Author 📜**
<hr>
<img align="right" alt="example image tag" src="https://i.imgur.com/jtNwEWu.png" width="200" />
<!-- badge cluster -->
<!-- / -->
See [License](LICENSE) for the full license text.
This repository was authored by *Isaac Yep*. \
[PyPi Package](https://pypi.org/project/powerjira/#table-of-contents)
[Back to Table of Contents](#table-of-contents-)
Raw data
{
"_id": null,
"home_page": "https://github.com/anthonybench/powerjira",
"name": "powerjira",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "jira,poetry",
"author": "sleepyboy",
"author_email": "anthonybenchyep@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bb/0e/ca0103a8ff9fcd35549156b1666b81c9836dba6325ca954af0e5b7f0461c/powerjira-0.3.4.tar.gz",
"platform": null,
"description": "# **PowerJira**\n*A succinct local jira control plane.*\n\n<br />\n\n## **Welcome to PowerJira!**\nHate how visually noise and clunky the Jira web-app is? Ever wish you could manage your jira account with a minimalistic interface?\n\nWelcome to the party! \ud83e\udd73\n\n<br />\n\n### **Table of Contents** \ud83d\udcd6\n<hr>\n\n - [Welcome](#welcome-to-powerjira)\n - [**Get Started**](#get-started-)\n - [Usage](#usage-)\n - [Technologies](#technologies-)\n - [Contribute](#Contribute-)\n - [Acknowledgements](#acknowledgements-)\n - [License/Stats/Author](#license-stats-author-)\n\n<br />\n\n## **Get Started \ud83d\ude80**\n<hr>\n\n```sh\npip install powerjira\npip install --upgrade powerjira\n```\n\n<br />\n\n## **Usage \u2699**\n<hr>\n\nSet an alias in your shell environment to open up an editor workspace you want to use powerjira in. \\\nThen set another alias to run a script like:\n```python\n# pip install powerjira\n# pip install --upgrade powerjira\n\nfrom powerjira import powerjira\nfrom sys import argv, exit\n\nconfig_path = 'config.yml'\nagent_path = 'agent.yml'\nsummary_path = 'summary.txt'\ndescription_path = 'description.txt'\n\npowerjira(\n config_path,\n agent_path,\n summary_path,\n description_path,\n argv[1:]\n)\nexit(0)\n```\n\nMake your local config files:\n```sh\ntouch summary.txt description.txt config.yml agent.yml\n```\n\nFor the configuration files:\n**config.yml**\n```yaml\nproject : <project-key>\npriority : <priority>\n\nissue_type : <type>\nepicKey : # Leave as empty for standalone task or epic\n\nreporter : <reporter-account-id>\nassignee : <assignee-account-id>\n```\n**agent.yml**\n```yaml\ndomain: <host>\n\nuser_name: <email>\ntoken: <jira-access-token>\n```\n\nPresuming you've named said shell alias `pj`, print the help message:\n```sh\npj --help\n```\n\n<br />\n\n## **Technologies \ud83e\uddf0**\n<hr>\n\n - [PyYAML](https://pypi.org/project/PyYAML/)\n - [python-jira](https://pypi.org/project/jira/)\n - [Poetry](https://python-poetry.org/)\n - [Typer](https://typer.tiangolo.com/)\n\n<br />\n\n## **Contribute \ud83e\udd1d**\n<hr>\n\nFeel free to push PR's to help make this tool more extensible/flexible.\n\n<br />\n\n## **Acknowledgements \ud83d\udc99**\n<hr>\n\nThanks to Atlassian for making market-leading tools that kinda frustrate me.\n\n<br />\n\n## **License, Stats, Author \ud83d\udcdc**\n<hr>\n\n<img align=\"right\" alt=\"example image tag\" src=\"https://i.imgur.com/jtNwEWu.png\" width=\"200\" />\n\n<!-- badge cluster -->\n\n\n\n\n<!-- / -->\nSee [License](LICENSE) for the full license text.\n\nThis repository was authored by *Isaac Yep*. \\\n[PyPi Package](https://pypi.org/project/powerjira/#table-of-contents)\n\n[Back to Table of Contents](#table-of-contents-)",
"bugtrack_url": null,
"license": "GNU GPL",
"summary": "A succinct, minimal local jira control plane that can live in your text editor. Interface with tickets fast!",
"version": "0.3.4",
"project_urls": {
"Homepage": "https://github.com/anthonybench/powerjira",
"Repository": "https://github.com/anthonybench/powerjira"
},
"split_keywords": [
"jira",
"poetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d113825302518f6247311b68c84c48053336d956166783af695c2e14ba3ced2",
"md5": "538a019cd8cb8d068645a65b0ea1e30f",
"sha256": "16ff5c522306ac74c5b041e1540d7d245dc4069a69b499d6a68b099c4b4c7bac"
},
"downloads": -1,
"filename": "powerjira-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "538a019cd8cb8d068645a65b0ea1e30f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 18071,
"upload_time": "2023-08-04T22:46:30",
"upload_time_iso_8601": "2023-08-04T22:46:30.016587Z",
"url": "https://files.pythonhosted.org/packages/1d/11/3825302518f6247311b68c84c48053336d956166783af695c2e14ba3ced2/powerjira-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb0eca0103a8ff9fcd35549156b1666b81c9836dba6325ca954af0e5b7f0461c",
"md5": "24bebecf1a423d986b0306a11a271f11",
"sha256": "47bec9509038cd4eb990a39556d45422b615982f6d64512b14068d5b4511eec9"
},
"downloads": -1,
"filename": "powerjira-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "24bebecf1a423d986b0306a11a271f11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 17372,
"upload_time": "2023-08-04T22:46:31",
"upload_time_iso_8601": "2023-08-04T22:46:31.232033Z",
"url": "https://files.pythonhosted.org/packages/bb/0e/ca0103a8ff9fcd35549156b1666b81c9836dba6325ca954af0e5b7f0461c/powerjira-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-04 22:46:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anthonybench",
"github_project": "powerjira",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "powerjira"
}
JSON
