jirasify 2.0.0__py3-none-any.whl

jirasify-2.0.0.dist-info/METADATA

@@ -0,0 +1,214 @@
+Metadata-Version: 2.4
+Name: jirasify
+Version: 2.0.0
+Summary: Terminal UI for Jira worklogs and status transitions
+Author-email: Jakob Holst <code@jakobholst.dk>
+License: MIT
+Project-URL: Homepage, https://gitlab.com/jakobholst/jaho_local_bin
+Project-URL: Repository, https://gitlab.com/jakobholst/jaho_local_bin
+Keywords: jira,tui,worklog,textual,terminal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+Requires-Dist: textual>=0.50
+Requires-Dist: pyyaml>=6.0
+
+# jirasify
+
+Terminal UI for logging work and moving Jira issues, built with [Textual](https://textual.textualize.io/).
+
+The distribution name on PyPI is `jirasify`; the main CLI command is `jirasify-tui`; the importable Python module is `jiratui`.
+
+## Install
+
+```bash
+pip install jirasify
+```
+
+## Configure
+
+On first run, `jirasify-tui` writes a template config to `~/.local/etc/jiratui/config.yaml` and prints a usage page. Edit the file (or answer the interactive prompt to fill it) with your Jira URL, project key, and username.
+
+Your Jira token is read from the environment variable named by `authentication.token_env` (default: `JIRATOKEN`):
+
+```bash
+export JIRATOKEN=your_token
+```
+
+- **Self-hosted Jira (Data Center / Server)**: use a **Personal Access Token**. It is sent as `Authorization: Bearer <token>`.
+- **Atlassian Cloud** (URL contains `atlassian.net`): use an **API token** from your Atlassian account. It is combined with `assignee.username` (your account email) via HTTP Basic auth.
+
+Verify connectivity before launching the TUI:
+
+```bash
+jirasify-tui --test
+```
+
+Prints the configured URL and token env var, then hits `/rest/api/2/myself`. Exits with a non-zero status on missing config, unset token, or auth failure.
+
+## Usage
+
+```bash
+jirasify-tui
+```
+
+| Key      | Action                            |
+| -------- | --------------------------------- |
+| `l`      | Log view                          |
+| `o`      | Overview                          |
+| `r`      | Monthly report                    |
+| `t`/`w`  | Today's / this week's report      |
+| `m`      | This month's report               |
+| `s`      | Change status of selected issue   |
+| `e`      | Set estimate on selected issue    |
+| `h`      | Help                              |
+| `Ctrl+R` | Refresh                           |
+| `q`      | Quit                              |
+
+Time input accepts `30m`, `1h`, `2h30m`, `1d` (a day = 8h).
+
+## `jirasify`
+
+`pip install jirasify` also installs a `jirasify` command that turns a
+structured Markdown file into Jira user stories using the same
+`~/.local/etc/jiratui/config.yaml` and `JIRATOKEN` env var as `jirasify-tui`.
+
+Expected Markdown layout:
+
+```markdown
+# My Epic Name - User Stories
+
+## 1. Project Overview
+
+Free text.
+
+---
+
+# Phase 1 - Foundations
+
+## User Story 001 - Inventory Environment
+
+**Estimate:** 15 h
+
+> As a developer, I will document ... so that ...
+
+### Scope
+- Item A
+- Item B
+
+### Acceptance Criteria
+- Criterion 1
+- Criterion 2
+```
+
+- The top-level `# ...` heading (any H1 that is not a `# Phase ...`) is used
+  as the Epic name. A trailing ` - User Stories` suffix is stripped.
+- Stories are only picked up under a `## User Story ...` heading inside a
+  `# Phase ...` section.
+- Recognised subsections: `Scope`, `Validate`, `Include`, `Examples`,
+  `Acceptance Criteria`.
+
+### Commands
+
+```bash
+jirasify --example                              # write ./example.md (plain markdown starter)
+jirasify --template --file stories.md.j2        # write an Ansible/Jinja2 template
+
+jirasify --file stories.md                      # parse + write .jirastories.state.json
+jirasify --file stories.md --create             # ensure Epic exists, create missing stories linked to it (idempotent)
+jirasify --file stories.md --status             # key/status/assignee/epic/estimate/used per story, grouped by phase with totals
+jirasify --file stories.md --epic VOS-100       # relink stories to a specific epic
+jirasify --file stories.md --epic VOS-100 --story VOS-142   # relink a single story
+
+jirasify --reverse VOS-1234                     # print a markdown reconstruction of an Epic and its stories
+jirasify --reverse VOS-1234 --save              # write it to <Epic_Name>.md (spaces -> _)
+```
+
+`--create` skips stories that already have an `issue_key` recorded in
+`.jirastories.state.json`, and also skips summaries that already exist in the
+target project, so re-runs won't duplicate issues. If no Epic with the H1's
+name exists, one is created before the stories.
+
+### Ansible / Jinja2 template
+
+`--template` emits a `.j2` scaffold expecting these variables:
+
+- `epic_name` (string)
+- `project_overview` (string, optional)
+- `phases`: list of `{ name, stories: [ { id, summary, estimate, description, scope?, acceptance_criteria? } ] }`
+
+Render it with `ansible.builtin.template` (or `jinja2.Template`) to produce
+a `stories.md`, then run `jirasify --file stories.md --create`.
+
+## `jirasify-list`
+
+`pip install jirasify` also installs a `jirasify-list` command for read-only
+listing of Jira objects, using the same config as `jirasify-tui`.
+
+```bash
+jirasify-list --epics                     # Epics in jira.project (config), excluding Cancelled and Done
+jirasify-list --epics --key VOS           # override the project key
+```
+
+### Status filters (mutually exclusive)
+
+```bash
+jirasify-list --epics --active            # status = Implementing
+jirasify-list --epics --planning          # status = Planning
+jirasify-list --epics --done              # status = Done
+jirasify-list --epics --cancelled         # status = Cancelled
+```
+
+Without any of these flags, Cancelled and Done epics are hidden by default.
+
+### Parent Link filter
+
+```bash
+jirasify-list --epics --parent VOS-100    # exact parent (JQL: "Parent Link" = VOS-100)
+jirasify-list --epics --parent VOS        # any parent whose key starts with VOS-
+```
+
+### Full hierarchy
+
+```bash
+jirasify-list --epics --full              # also show stories under each epic and subtasks under each story
+```
+
+`--full` issues one extra batched JQL for all epic children (`"Epic Link" in (…)`)
+and one for all subtasks (`parent in (…)`), regardless of item count.
+
+### Output
+
+Epics are grouped by their Parent Link and printed as a tree with box-drawing
+branches (`├──`, `└──`, `│`):
+
+```
+VOS-100  Digital Platform Modernization
+├── VOS-215      Implementing         Jane Doe                          Artifactory PyPI
+│   ├── VOS-231    In Progress          Bob                               Provision PyPI local repo
+│   │   └── VOS-232  To Do                Alice                             Configure retention
+│   └── VOS-233    To Do                Bob                               Assemble virtual PyPI
+└── VOS-220      To Do                Bob                               Sisyphos Onboarding
+
+VOS-105  Infrastructure 2026
+└── VOS-311      Implementing         Alice                             VMware 9.1 Enablement
+
+(no parent)
+└── VOS-999      Planning             Unassigned                        Ad-hoc Epic
+```
+
+Columns per row: issue key, status, assignee (truncated to 32 chars with `…`),
+and the label — Epic Name for epics (falls back to summary when the Epic Name
+custom field is absent), summary for stories and subtasks. Without `--full`
+only the epic level is shown.
+
+Rows are colorized when stdout is a terminal: cyan parent header, magenta
+epic, green story, blue subtask. Piping or redirecting produces plain output.

jirasify-2.0.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+jiratui/__init__.py,sha256=_7OlQdbVkK4jad0CLdpI0grT-zEAb-qgFmH5mFzDXiA,22
+jiratui/__main__.py,sha256=bMpoFFpF2nVN33UhGKsbgITuEBaKzxYn2RlvhTNq-YA,69
+jiratui/app.py,sha256=VfVHfBriUiVxd7SVjFyUBCRaT_55Y6PVQkvbj7jyG8E,23817
+jiratui/client.py,sha256=Pi4doMYy9GuWxnHU2HjK0uG38VEMFvVO-8DD61PQsbs,17589
+jiratui/config.py,sha256=irSsk00aCVWNXLMP_UkzGgLs3NCCiutePY04MOd54E0,3038
+jiratui/dailywork.py,sha256=vPEwpFiO1WcLr9ynaLldF37JdfU5JTJWC2ulb9ZWmcA,1511
+jiratui/jira_list.py,sha256=xFEfNcDBtWbm7AfSx4AinQpO_-851vASANRWKEeV_RM,6863
+jiratui/markdown2jira.py,sha256=pN_zptBUEprruJLrvTMPYKEKX7OccQgv86evcSrp0v4,14831
+jiratui/screens.py,sha256=nRmSsY9QYumGzaxxViO7SITgect5fcZ72rammIqd4sc,3348
+jiratui/utils.py,sha256=kM-rs588yukdemayJKiKT-1UWO-lWKA8_r_zNjuiUgs,2362
+jirasify-2.0.0.dist-info/METADATA,sha256=-r-ioLXE99AmOyO8hp8jah4w4og0hj3JKSqp2E-K9GQ,7862
+jirasify-2.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+jirasify-2.0.0.dist-info/entry_points.txt,sha256=v3STPxYLswPnP2osER5HsQirkUZlfqLb84ulzo6iJd4,127
+jirasify-2.0.0.dist-info/top_level.txt,sha256=ZbjXr-sKCqXtcwtYNTKdyp5U9HANeWz05NmCGthppd4,8
+jirasify-2.0.0.dist-info/RECORD,,

jirasify-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

jirasify-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+jirasify = jiratui.markdown2jira:main
+jirasify-list = jiratui.jira_list:main
+jirasify-tui = jiratui.app:main

jirasify-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+jiratui

jiratui/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.0.0"

jiratui/__main__.py

@@ -0,0 +1,5 @@
+from jiratui.app import main
+
+
+if __name__ == "__main__":
+    main()