backlog-atlas 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. backlog_atlas-0.1.0/LICENSE +21 -0
  2. backlog_atlas-0.1.0/PKG-INFO +129 -0
  3. backlog_atlas-0.1.0/README.md +118 -0
  4. backlog_atlas-0.1.0/backlog_atlas/__init__.py +1915 -0
  5. backlog_atlas-0.1.0/backlog_atlas/config.yaml +58 -0
  6. backlog_atlas-0.1.0/backlog_atlas/templates/__init__.py +1 -0
  7. backlog_atlas-0.1.0/backlog_atlas/templates/backlog.md.tmpl +56 -0
  8. backlog_atlas-0.1.0/backlog_atlas/templates/backlog_updates_entry.md.tmpl +6 -0
  9. backlog_atlas-0.1.0/backlog_atlas/templates/workflow.yml.tmpl +120 -0
  10. backlog_atlas-0.1.0/backlog_atlas/web/__init__.py +1 -0
  11. backlog_atlas-0.1.0/backlog_atlas/web/index.html +631 -0
  12. backlog_atlas-0.1.0/backlog_atlas.egg-info/PKG-INFO +129 -0
  13. backlog_atlas-0.1.0/backlog_atlas.egg-info/SOURCES.txt +18 -0
  14. backlog_atlas-0.1.0/backlog_atlas.egg-info/dependency_links.txt +1 -0
  15. backlog_atlas-0.1.0/backlog_atlas.egg-info/entry_points.txt +2 -0
  16. backlog_atlas-0.1.0/backlog_atlas.egg-info/requires.txt +1 -0
  17. backlog_atlas-0.1.0/backlog_atlas.egg-info/top_level.txt +1 -0
  18. backlog_atlas-0.1.0/pyproject.toml +28 -0
  19. backlog_atlas-0.1.0/setup.cfg +4 -0
  20. backlog_atlas-0.1.0/tests/test_update_backlog.py +699 -0
backlog_atlas-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Omry Yadan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
backlog_atlas-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,129 @@
1
+ Metadata-Version: 2.4
2
+ Name: backlog-atlas
3
+ Version: 0.1.0
4
+ Summary: Generate a self-hosted backlog snapshot and dashboard for maintainers.
5
+ License-Expression: MIT
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Requires-Dist: omegaconf>=2.3
10
+ Dynamic: license-file
11
+
12
+ # Backlog Atlas
13
+
14
+ Generates a self-hosted backlog snapshot and dashboard for maintainers.
15
+
16
+ Backlog Atlas keeps the issue tracker as the source of truth and publishes a
17
+ derived view of one repository's open issues, linked pull requests, status, and
18
+ recent backlog activity.
19
+
20
+ ## What it produces
21
+
22
+ Outputs land on a dedicated `backlog-atlas` branch (kept off `main` so issue churn doesn't pollute the main history):
23
+
24
+ - `BACKLOG.md` — categorized table of open issues + recently-done.
25
+ - `BACKLOG-UPDATES.md` — append-only human changelog of new/closed/status/label events.
26
+ - `backlog.json` — same data as `BACKLOG.md` but structured, consumed by the web UI.
27
+ - `updates.jsonl` — append-only structured event log (machine-readable changelog). Bootstrapped from `BACKLOG-UPDATES.md` on first run.
28
+ - `last_snapshot.json` — internal state used to diff against the next run.
29
+ - `events.jsonl` — log of GitHub issue/PR events queued for the next debounced run.
30
+ - `index.html` — bundled with the package; copied to the `backlog-atlas` branch by the workflow so a static page can be served via GitHub Pages.
31
+
32
+ ## Install
33
+
34
+ ```
35
+ pip install .
36
+ # or, once published:
37
+ # pip install backlog-atlas
38
+ ```
39
+
40
+ ## CLI
41
+
42
+ ```
43
+ backlog-atlas update [flags] # regenerate outputs from current GitHub state
44
+ backlog-atlas install [flags] # set up backlog-atlas branch + workflow YAML in a target repo
45
+ backlog-atlas uninstall [flags] # reverse install
46
+ backlog-atlas dump-web --output X # write the bundled index.html (or full web/ dir)
47
+ ```
48
+
49
+ ### `update`
50
+
51
+ Fetches issues/PRs from GitHub via `gh` and rewrites the backlog files. Useful flags:
52
+
53
+ - `--repo owner/name` — override repo detection (defaults to `sl`/`git` remote).
54
+ - `--dry-run` — print what would change without writing.
55
+ - `--snapshot-path` / `--event-log-path` / `--commit-msg-path` — workflow-driven I/O paths.
56
+ - `--data-json-path` / `--updates-jsonl-path` — override default output locations.
57
+
58
+ Defaults write everything under `<target-repo>/.backlog-atlas/` so the file system isn't littered.
59
+
60
+ ### `install`
61
+
62
+ ```
63
+ backlog-atlas install --repo owner/name [--pip-spec <pip arg>]
64
+ ```
65
+
66
+ Creates the `backlog-atlas` branch via the GitHub API (if missing) and drops `.github/workflows/update-backlog-atlas.yml` into the target repo. The generated workflow does `pip install <pip-spec>` and runs `backlog-atlas update` + `backlog-atlas dump-web`. Default `--pip-spec` is `backlog-atlas` (PyPI). Override with a git URL or local path until publication.
67
+
68
+ ### `uninstall`
69
+
70
+ Removes the workflow YAML and (with confirmation) deletes the `backlog-atlas` branch.
71
+
72
+ ## Web UI
73
+
74
+ The page is served from the `backlog-atlas` branch via GitHub Pages: enable Pages → branch `backlog-atlas` / `/`. It fetches `backlog.json` and renders an interactive view with search, category/status filters, sortable columns, dark/light themes, and a fixed bottom activity panel.
75
+
76
+ For local preview:
77
+
78
+ ```
79
+ backlog-atlas dump-web --output ./preview/
80
+ backlog-atlas update --data-json-path ./preview/backlog.json
81
+ cd preview && python3 -m http.server 8000
82
+ # open http://localhost:8000/
83
+ ```
84
+
85
+ ## Tests
86
+
87
+ ```
88
+ pytest tests/test_update_backlog.py
89
+ ```
90
+
91
+ ## Maintainers
92
+
93
+ See [`MAINTAINERS.md`](./MAINTAINERS.md) for local development, testing,
94
+ packaging, and publishing notes.
95
+
96
+ ## Publishing
97
+
98
+ Publishing uses PyPI Trusted Publishing from `.github/workflows/publish.yml`.
99
+ Configure the PyPI publisher for:
100
+
101
+ - repository: `omry/backlog-atlas`
102
+ - workflow: `publish.yml`
103
+ - environment: `pypi`
104
+
105
+ The workflow builds and publishes when a GitHub Release is published.
106
+
107
+ ## License
108
+
109
+ MIT.
110
+
111
+ ## Layout
112
+
113
+ ```
114
+ .
115
+ ├── pyproject.toml
116
+ ├── README.md
117
+ ├── MAINTAINERS.md
118
+ ├── backlog_atlas/
119
+ │ ├── __init__.py # CLI + all logic (single-module package for now)
120
+ │ ├── config.yaml # default category/keyword/emoji config
121
+ │ ├── templates/
122
+ │ │ ├── backlog.md.tmpl
123
+ │ │ ├── backlog_updates_entry.md.tmpl
124
+ │ │ └── workflow.yml.tmpl # GitHub Actions workflow template installed by `install`
125
+ │ └── web/
126
+ │ └── index.html # bundled static UI
127
+ └── tests/
128
+ └── test_update_backlog.py
129
+ ```
backlog_atlas-0.1.0/README.md ADDED
@@ -0,0 +1,118 @@
1
+ # Backlog Atlas
2
+
3
+ Generates a self-hosted backlog snapshot and dashboard for maintainers.
4
+
5
+ Backlog Atlas keeps the issue tracker as the source of truth and publishes a
6
+ derived view of one repository's open issues, linked pull requests, status, and
7
+ recent backlog activity.
8
+
9
+ ## What it produces
10
+
11
+ Outputs land on a dedicated `backlog-atlas` branch (kept off `main` so issue churn doesn't pollute the main history):
12
+
13
+ - `BACKLOG.md` — categorized table of open issues + recently-done.
14
+ - `BACKLOG-UPDATES.md` — append-only human changelog of new/closed/status/label events.
15
+ - `backlog.json` — same data as `BACKLOG.md` but structured, consumed by the web UI.
16
+ - `updates.jsonl` — append-only structured event log (machine-readable changelog). Bootstrapped from `BACKLOG-UPDATES.md` on first run.
17
+ - `last_snapshot.json` — internal state used to diff against the next run.
18
+ - `events.jsonl` — log of GitHub issue/PR events queued for the next debounced run.
19
+ - `index.html` — bundled with the package; copied to the `backlog-atlas` branch by the workflow so a static page can be served via GitHub Pages.
20
+
21
+ ## Install
22
+
23
+ ```
24
+ pip install .
25
+ # or, once published:
26
+ # pip install backlog-atlas
27
+ ```
28
+
29
+ ## CLI
30
+
31
+ ```
32
+ backlog-atlas update [flags] # regenerate outputs from current GitHub state
33
+ backlog-atlas install [flags] # set up backlog-atlas branch + workflow YAML in a target repo
34
+ backlog-atlas uninstall [flags] # reverse install
35
+ backlog-atlas dump-web --output X # write the bundled index.html (or full web/ dir)
36
+ ```
37
+
38
+ ### `update`
39
+
40
+ Fetches issues/PRs from GitHub via `gh` and rewrites the backlog files. Useful flags:
41
+
42
+ - `--repo owner/name` — override repo detection (defaults to `sl`/`git` remote).
43
+ - `--dry-run` — print what would change without writing.
44
+ - `--snapshot-path` / `--event-log-path` / `--commit-msg-path` — workflow-driven I/O paths.
45
+ - `--data-json-path` / `--updates-jsonl-path` — override default output locations.
46
+
47
+ Defaults write everything under `<target-repo>/.backlog-atlas/` so the file system isn't littered.
48
+
49
+ ### `install`
50
+
51
+ ```
52
+ backlog-atlas install --repo owner/name [--pip-spec <pip arg>]
53
+ ```
54
+
55
+ Creates the `backlog-atlas` branch via the GitHub API (if missing) and drops `.github/workflows/update-backlog-atlas.yml` into the target repo. The generated workflow does `pip install <pip-spec>` and runs `backlog-atlas update` + `backlog-atlas dump-web`. Default `--pip-spec` is `backlog-atlas` (PyPI). Override with a git URL or local path until publication.
56
+
57
+ ### `uninstall`
58
+
59
+ Removes the workflow YAML and (with confirmation) deletes the `backlog-atlas` branch.
60
+
61
+ ## Web UI
62
+
63
+ The page is served from the `backlog-atlas` branch via GitHub Pages: enable Pages → branch `backlog-atlas` / `/`. It fetches `backlog.json` and renders an interactive view with search, category/status filters, sortable columns, dark/light themes, and a fixed bottom activity panel.
64
+
65
+ For local preview:
66
+
67
+ ```
68
+ backlog-atlas dump-web --output ./preview/
69
+ backlog-atlas update --data-json-path ./preview/backlog.json
70
+ cd preview && python3 -m http.server 8000
71
+ # open http://localhost:8000/
72
+ ```
73
+
74
+ ## Tests
75
+
76
+ ```
77
+ pytest tests/test_update_backlog.py
78
+ ```
79
+
80
+ ## Maintainers
81
+
82
+ See [`MAINTAINERS.md`](./MAINTAINERS.md) for local development, testing,
83
+ packaging, and publishing notes.
84
+
85
+ ## Publishing
86
+
87
+ Publishing uses PyPI Trusted Publishing from `.github/workflows/publish.yml`.
88
+ Configure the PyPI publisher for:
89
+
90
+ - repository: `omry/backlog-atlas`
91
+ - workflow: `publish.yml`
92
+ - environment: `pypi`
93
+
94
+ The workflow builds and publishes when a GitHub Release is published.
95
+
96
+ ## License
97
+
98
+ MIT.
99
+
100
+ ## Layout
101
+
102
+ ```
103
+ .
104
+ ├── pyproject.toml
105
+ ├── README.md
106
+ ├── MAINTAINERS.md
107
+ ├── backlog_atlas/
108
+ │ ├── __init__.py # CLI + all logic (single-module package for now)
109
+ │ ├── config.yaml # default category/keyword/emoji config
110
+ │ ├── templates/
111
+ │ │ ├── backlog.md.tmpl
112
+ │ │ ├── backlog_updates_entry.md.tmpl
113
+ │ │ └── workflow.yml.tmpl # GitHub Actions workflow template installed by `install`
114
+ │ └── web/
115
+ │ └── index.html # bundled static UI
116
+ └── tests/
117
+ └── test_update_backlog.py
118
+ ```