github-milestone-roadmap 0.1.0__py3-none-any.whl

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.
@@ -0,0 +1,589 @@
1
+ :root {
2
+ color-scheme: light;
3
+ --bg: #f5f7fb;
4
+ --panel: #ffffff;
5
+ --panel-strong: #101827;
6
+ --text: #172033;
7
+ --muted: #667085;
8
+ --line: #dde4f0;
9
+ --blue: #315efb;
10
+ --blue-soft: #e8edff;
11
+ --green: #147a4b;
12
+ --green-soft: #e9f8ef;
13
+ --amber: #946200;
14
+ --amber-soft: #fff4d8;
15
+ --red: #b42318;
16
+ --shadow: 0 24px 70px rgba(22, 35, 63, 0.12);
17
+ }
18
+
19
+ * {
20
+ box-sizing: border-box;
21
+ }
22
+
23
+ html {
24
+ scroll-behavior: smooth;
25
+ scroll-padding-top: 18px;
26
+ }
27
+
28
+ body {
29
+ margin: 0;
30
+ min-height: 100vh;
31
+ background:
32
+ radial-gradient(circle at top left, rgba(49, 94, 251, 0.12), transparent 24rem),
33
+ linear-gradient(180deg, #ffffff 0, var(--bg) 16rem);
34
+ color: var(--text);
35
+ font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
36
+ line-height: 1.5;
37
+ }
38
+
39
+ a {
40
+ color: inherit;
41
+ }
42
+
43
+ .site-header,
44
+ main,
45
+ .site-footer {
46
+ width: min(1180px, calc(100% - 32px));
47
+ margin: 0 auto;
48
+ }
49
+
50
+ .nav {
51
+ display: flex;
52
+ align-items: center;
53
+ justify-content: space-between;
54
+ padding: 14px 0;
55
+ color: var(--muted);
56
+ font-weight: 650;
57
+ }
58
+
59
+ .nav a {
60
+ text-decoration: none;
61
+ }
62
+
63
+ .brand {
64
+ color: var(--panel-strong);
65
+ font-size: 1.05rem;
66
+ letter-spacing: 0.08em;
67
+ }
68
+
69
+ .github-link {
70
+ display: inline-flex;
71
+ gap: 7px;
72
+ align-items: center;
73
+ }
74
+
75
+ .github-link svg {
76
+ width: 18px;
77
+ height: 18px;
78
+ fill: currentColor;
79
+ }
80
+
81
+ .github-link:hover,
82
+ .github-link:focus-visible {
83
+ color: var(--blue);
84
+ }
85
+
86
+ .hero {
87
+ max-width: 850px;
88
+ padding: 24px 0 28px;
89
+ }
90
+
91
+ h1,
92
+ h2,
93
+ h3,
94
+ p {
95
+ margin-top: 0;
96
+ }
97
+
98
+ h1 {
99
+ margin-bottom: 8px;
100
+ color: var(--panel-strong);
101
+ font-size: clamp(2.1rem, 5vw, 3.6rem);
102
+ line-height: 1;
103
+ letter-spacing: -0.055em;
104
+ }
105
+
106
+ .subtitle {
107
+ margin-bottom: 12px;
108
+ max-width: 700px;
109
+ color: var(--muted);
110
+ font-size: clamp(1rem, 2.2vw, 1.25rem);
111
+ font-weight: 720;
112
+ letter-spacing: -0.02em;
113
+ }
114
+
115
+ .hero blockquote {
116
+ max-width: 670px;
117
+ margin: 0;
118
+ padding: 9px 13px;
119
+ border-left: 3px solid var(--blue);
120
+ border-radius: 0 12px 12px 0;
121
+ background: rgba(255, 255, 255, 0.72);
122
+ color: var(--muted);
123
+ font-size: 0.9rem;
124
+ }
125
+
126
+ .repo-jump {
127
+ display: flex;
128
+ flex-wrap: wrap;
129
+ gap: 8px;
130
+ align-items: center;
131
+ margin-top: 12px;
132
+ color: var(--muted);
133
+ font-size: 0.86rem;
134
+ }
135
+
136
+ .repo-jump span {
137
+ margin-right: 4px;
138
+ font-weight: 750;
139
+ }
140
+
141
+ .repo-jump a {
142
+ border: 1px solid var(--line);
143
+ border-radius: 999px;
144
+ background: rgba(255, 255, 255, 0.8);
145
+ color: var(--blue);
146
+ font-weight: 750;
147
+ padding: 4px 10px;
148
+ text-decoration: none;
149
+ }
150
+
151
+ .repo-jump a:hover,
152
+ .repo-jump a:focus-visible {
153
+ border-color: var(--blue);
154
+ background: var(--blue-soft);
155
+ }
156
+
157
+ .site-footer p {
158
+ margin-bottom: 0;
159
+ color: var(--muted);
160
+ }
161
+
162
+ button {
163
+ border: 0;
164
+ border-radius: 999px;
165
+ background: var(--panel-strong);
166
+ color: white;
167
+ cursor: pointer;
168
+ font: inherit;
169
+ font-weight: 750;
170
+ padding: 11px 18px;
171
+ }
172
+
173
+ button:disabled {
174
+ cursor: wait;
175
+ opacity: 0.65;
176
+ }
177
+
178
+ button:hover,
179
+ button:focus-visible {
180
+ background: var(--blue);
181
+ }
182
+
183
+ .roadmap {
184
+ display: grid;
185
+ gap: 26px;
186
+ }
187
+
188
+ .package-card {
189
+ overflow: hidden;
190
+ border: 1px solid var(--line);
191
+ border-radius: 30px;
192
+ background: var(--panel);
193
+ box-shadow: var(--shadow);
194
+ }
195
+
196
+ .package-header {
197
+ display: flex;
198
+ gap: 18px;
199
+ align-items: start;
200
+ justify-content: space-between;
201
+ padding: 28px;
202
+ border-bottom: 1px solid var(--line);
203
+ background: linear-gradient(135deg, #ffffff, #f6f8ff);
204
+ }
205
+
206
+ .package-header h2 {
207
+ margin-bottom: 6px;
208
+ color: var(--panel-strong);
209
+ font-size: clamp(1.5rem, 4vw, 2.2rem);
210
+ letter-spacing: -0.04em;
211
+ }
212
+
213
+ .package-header p {
214
+ margin-bottom: 0;
215
+ color: var(--muted);
216
+ }
217
+
218
+ .repo-link {
219
+ flex: 0 0 auto;
220
+ border: 1px solid var(--line);
221
+ border-radius: 999px;
222
+ color: var(--blue);
223
+ font-size: 0.9rem;
224
+ font-weight: 750;
225
+ padding: 8px 13px;
226
+ text-decoration: none;
227
+ }
228
+
229
+ .package-actions {
230
+ display: flex;
231
+ flex: 0 0 auto;
232
+ flex-wrap: wrap;
233
+ gap: 10px;
234
+ justify-content: flex-end;
235
+ }
236
+
237
+ .reload-button {
238
+ display: inline-flex;
239
+ align-items: center;
240
+ gap: 7px;
241
+ padding: 8px 13px;
242
+ font-size: 0.9rem;
243
+ }
244
+
245
+ .reload-icon {
246
+ display: inline-block;
247
+ font-size: 1rem;
248
+ line-height: 1;
249
+ }
250
+
251
+ .reload-button:disabled .reload-icon {
252
+ animation: spin 900ms linear infinite;
253
+ }
254
+
255
+ @keyframes spin {
256
+ to {
257
+ transform: rotate(360deg);
258
+ }
259
+ }
260
+
261
+ .release-list {
262
+ display: grid;
263
+ padding: 10px 28px 24px;
264
+ }
265
+
266
+ .release-nav {
267
+ display: flex;
268
+ flex-wrap: wrap;
269
+ gap: 8px;
270
+ align-items: center;
271
+ padding: 14px 0 12px;
272
+ color: var(--muted);
273
+ font-size: 0.86rem;
274
+ }
275
+
276
+ .release-nav span {
277
+ margin-right: 4px;
278
+ font-weight: 750;
279
+ }
280
+
281
+ .release-nav a {
282
+ border: 1px solid var(--line);
283
+ border-radius: 999px;
284
+ background: #ffffff;
285
+ color: var(--blue);
286
+ font-weight: 750;
287
+ padding: 4px 10px;
288
+ text-decoration: none;
289
+ }
290
+
291
+ .release-nav a:hover,
292
+ .release-nav a:focus-visible {
293
+ border-color: var(--blue);
294
+ background: var(--blue-soft);
295
+ }
296
+
297
+ .release-row {
298
+ display: grid;
299
+ grid-template-columns: minmax(92px, 150px) 1fr;
300
+ gap: 18px;
301
+ padding: 20px 0;
302
+ border-top: 1px solid var(--line);
303
+ }
304
+
305
+ .release-label {
306
+ position: sticky;
307
+ top: 18px;
308
+ align-self: start;
309
+ }
310
+
311
+ .release-label h3 {
312
+ margin-bottom: 0;
313
+ color: var(--panel-strong);
314
+ font-size: clamp(1.15rem, 2.8vw, 1.55rem);
315
+ }
316
+
317
+ .release-label .pill {
318
+ display: inline-block;
319
+ margin-top: 8px;
320
+ }
321
+
322
+ .release-counts {
323
+ display: flex;
324
+ flex-wrap: wrap;
325
+ gap: 6px;
326
+ margin-top: 8px;
327
+ }
328
+
329
+ .release-count {
330
+ border-radius: 999px;
331
+ background: #f1f4f9;
332
+ color: var(--muted);
333
+ font-size: 0.76rem;
334
+ font-weight: 720;
335
+ padding: 3px 8px;
336
+ text-decoration: none;
337
+ }
338
+
339
+ a.release-count:hover,
340
+ a.release-count:focus-visible {
341
+ background: var(--blue-soft);
342
+ color: var(--blue);
343
+ }
344
+
345
+ .release-grid {
346
+ display: grid;
347
+ gap: 14px;
348
+ }
349
+
350
+ .lane {
351
+ border: 1px solid var(--line);
352
+ border-radius: 16px;
353
+ background: rgba(255, 255, 255, 0.74);
354
+ padding: 14px;
355
+ }
356
+
357
+ .lane h4 {
358
+ display: flex;
359
+ align-items: center;
360
+ justify-content: space-between;
361
+ margin: 0 0 12px;
362
+ color: var(--panel-strong);
363
+ font-size: 0.98rem;
364
+ }
365
+
366
+ .milestone-link {
367
+ color: inherit;
368
+ text-decoration: none;
369
+ }
370
+
371
+ .milestone-link:hover,
372
+ .milestone-link:focus-visible {
373
+ color: var(--blue);
374
+ text-decoration: underline;
375
+ text-underline-offset: 3px;
376
+ }
377
+
378
+ .count {
379
+ border-radius: 999px;
380
+ background: var(--blue-soft);
381
+ color: var(--blue);
382
+ font-size: 0.78rem;
383
+ padding: 2px 9px;
384
+ }
385
+
386
+ .item-list {
387
+ display: grid;
388
+ gap: 0;
389
+ margin: 0;
390
+ padding: 0;
391
+ list-style: none;
392
+ }
393
+
394
+ .item {
395
+ position: relative;
396
+ border-top: 1px solid #edf1f7;
397
+ padding: 11px 0;
398
+ }
399
+
400
+ .item::before {
401
+ position: absolute;
402
+ inset: 0 -14px;
403
+ z-index: 0;
404
+ background: transparent;
405
+ content: "";
406
+ transition: background-color 140ms ease;
407
+ }
408
+
409
+ .item:hover::before,
410
+ .item:focus-within::before {
411
+ background: #f6f8fb;
412
+ }
413
+
414
+ .item > * {
415
+ position: relative;
416
+ z-index: 1;
417
+ }
418
+
419
+ .item:first-child {
420
+ border-top: 0;
421
+ }
422
+
423
+ .item-title-row {
424
+ display: flex;
425
+ gap: 12px;
426
+ align-items: flex-start;
427
+ justify-content: space-between;
428
+ }
429
+
430
+ .item-actions {
431
+ display: flex;
432
+ flex: 0 0 auto;
433
+ flex-wrap: wrap;
434
+ gap: 6px;
435
+ justify-content: flex-end;
436
+ }
437
+
438
+ .item-title {
439
+ display: block;
440
+ min-width: 0;
441
+ color: var(--panel-strong);
442
+ font-weight: 500;
443
+ text-decoration: none;
444
+ }
445
+
446
+ .item-title:hover,
447
+ .item-title:focus-visible {
448
+ color: var(--blue);
449
+ }
450
+
451
+ .item-footer {
452
+ display: flex;
453
+ flex-wrap: wrap;
454
+ gap: 10px;
455
+ align-items: center;
456
+ justify-content: space-between;
457
+ margin-top: 8px;
458
+ }
459
+
460
+ .labels,
461
+ .people {
462
+ display: flex;
463
+ flex-wrap: wrap;
464
+ gap: 7px;
465
+ }
466
+
467
+ .people {
468
+ justify-content: flex-end;
469
+ margin-left: auto;
470
+ }
471
+
472
+ .pill {
473
+ border-radius: 999px;
474
+ background: #f1f4f9;
475
+ color: var(--muted);
476
+ font-size: 0.76rem;
477
+ font-weight: 720;
478
+ padding: 3px 8px;
479
+ }
480
+
481
+ .item-number {
482
+ border-radius: 999px;
483
+ background: #f1f4f9;
484
+ color: var(--muted);
485
+ font-size: 0.82rem;
486
+ font-weight: 720;
487
+ padding: 3px 8px;
488
+ text-decoration: none;
489
+ }
490
+
491
+ .item-number:hover,
492
+ .item-number:focus-visible {
493
+ background: var(--blue-soft);
494
+ color: var(--blue);
495
+ }
496
+
497
+ .review-status {
498
+ border-radius: 999px;
499
+ font-size: 0.76rem;
500
+ font-weight: 720;
501
+ padding: 3px 8px;
502
+ white-space: nowrap;
503
+ }
504
+
505
+ .review-status.review {
506
+ background: var(--amber-soft);
507
+ color: var(--amber);
508
+ }
509
+
510
+ .review-status.changes {
511
+ background: #fee4e2;
512
+ color: var(--red);
513
+ }
514
+
515
+ .review-status.approved {
516
+ background: var(--green-soft);
517
+ color: var(--green);
518
+ }
519
+
520
+ .person {
521
+ border-radius: 999px;
522
+ font-size: 0.76rem;
523
+ font-weight: 720;
524
+ padding: 3px 8px;
525
+ }
526
+
527
+ .person.owner {
528
+ background: var(--blue-soft);
529
+ color: var(--blue);
530
+ }
531
+
532
+ .person.assignee {
533
+ background: var(--green-soft);
534
+ color: var(--green);
535
+ }
536
+ font-size: 0.78rem;
537
+ font-weight: 650;
538
+ }
539
+
540
+ .empty {
541
+ margin: 0;
542
+ color: var(--muted);
543
+ font-size: 0.92rem;
544
+ }
545
+
546
+ .error {
547
+ border-color: rgba(180, 35, 24, 0.22);
548
+ background: #fff7f7;
549
+ }
550
+
551
+ .error .package-header {
552
+ background: #fff7f7;
553
+ }
554
+
555
+ .site-footer {
556
+ padding: 36px 0 44px;
557
+ }
558
+
559
+ @media (max-width: 760px) {
560
+ .hero {
561
+ padding: 18px 0 22px;
562
+ }
563
+
564
+ .package-header {
565
+ align-items: stretch;
566
+ flex-direction: column;
567
+ }
568
+
569
+ .repo-link {
570
+ width: fit-content;
571
+ }
572
+
573
+ .package-actions {
574
+ justify-content: flex-start;
575
+ }
576
+
577
+ .release-grid {
578
+ grid-template-columns: 1fr;
579
+ }
580
+
581
+ .release-row {
582
+ grid-template-columns: 1fr;
583
+ gap: 12px;
584
+ }
585
+
586
+ .release-label {
587
+ position: static;
588
+ }
589
+ }
@@ -0,0 +1,134 @@
1
+ Metadata-Version: 2.5
2
+ Name: github-milestone-roadmap
3
+ Version: 0.1.0
4
+ Summary: Build a live roadmap website from GitHub release milestones across several repositories
5
+ Project-URL: Repository, https://github.com/mllam/github-milestone-roadmap
6
+ Project-URL: Changelog, https://github.com/mllam/github-milestone-roadmap/blob/main/CHANGELOG.md
7
+ Author: Leif Denby
8
+ License-Expression: MIT
9
+ License-File: LICENSE
10
+ Classifier: Environment :: Console
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Topic :: Software Development :: Documentation
13
+ Requires-Python: >=3.11
14
+ Requires-Dist: httpx>=0.27
15
+ Description-Content-Type: text/markdown
16
+
17
+ # github-milestone-roadmap
18
+
19
+ Build a live roadmap website from GitHub release milestones across several
20
+ repositories.
21
+
22
+ The generated site is a single static page. It reads milestones, issues and
23
+ pull requests from the public GitHub API in the visitor's browser, so the
24
+ roadmap is always current without rebuilding the site. It is used for the
25
+ [mllam community roadmap](https://mllam.github.io/roadmap).
26
+
27
+ ## The milestone convention
28
+
29
+ Milestone names decide where an item appears:
30
+
31
+ - `vX.Y.Z`: the item is **on the roadmap** for that release.
32
+ - `vX.Y.Z (proposed)`: the item is **proposed** for that release.
33
+
34
+ For each release the page shows three lanes: open issues/PRs on the roadmap,
35
+ open proposed issues/PRs, and pull requests already merged into the `vX.Y.Z`
36
+ milestone. Open pull requests also show their review status. Milestones with
37
+ other names are ignored.
38
+
39
+ ## Usage
40
+
41
+ Write a `roadmap.toml` describing your roadmap (see
42
+ [`examples/roadmap.toml`](examples/roadmap.toml) for every option):
43
+
44
+ ```toml
45
+ title = "My Community Roadmap"
46
+ subtitle = "Upcoming work across our packages"
47
+ source_url = "https://github.com/my-org"
48
+
49
+ [home]
50
+ text = "My Community"
51
+ url = "/"
52
+
53
+ # One [[repos]] entry per repository; add as many as you like, in display order.
54
+ [[repos]]
55
+ owner = "my-org"
56
+ name = "my-package"
57
+ description = "What this package does."
58
+ ```
59
+
60
+ Then build the site:
61
+
62
+ ```sh
63
+ uvx github-milestone-roadmap build --config roadmap.toml --output _site/roadmap
64
+ ```
65
+
66
+ This writes `index.html`, `app.js`, `styles.css` and `config.json` to the
67
+ output directory. The page only uses relative paths, so it can be served from
68
+ any subpath.
69
+
70
+ ### In a GitHub Pages workflow
71
+
72
+ Pin the version so that roadmap tool updates reach your site only when you bump
73
+ it:
74
+
75
+ ```yaml
76
+ - uses: astral-sh/setup-uv@v6
77
+ - name: Build roadmap
78
+ run: uvx github-milestone-roadmap==0.1.0 build --config roadmap.toml --output _site/roadmap
79
+ - uses: actions/upload-pages-artifact@v3
80
+ with:
81
+ path: _site
82
+ ```
83
+
84
+ See the [mllam.github.io deploy workflow](https://github.com/mllam/mllam.github.io/blob/main/.github/workflows/pages.yml)
85
+ for a complete example.
86
+
87
+ ### API usage and caching
88
+
89
+ Without authentication, the GitHub API allows 60 requests per hour per
90
+ visitor. The page makes three requests per repository (open milestones, open
91
+ issues/PRs, recently closed PRs) plus one per displayed open pull request for
92
+ its review status. Responses are cached in the browser's `localStorage` for 15
93
+ minutes under the config's `cache_key`, and stale cached data is shown if the
94
+ rate limit is reached.
95
+
96
+ ## Milestone changes report
97
+
98
+ `changes` prints the issues and pull requests added to a `vX.Y.Z` milestone in
99
+ the last 24 hours across the configured repositories, grouped per repository
100
+ and version. The output is Markdown with nested lists, suitable for pasting
101
+ into Slack.
102
+
103
+ It uses the GraphQL API, so a GitHub token is required. With the
104
+ [`gh`](https://cli.github.com/) CLI logged in:
105
+
106
+ ```sh
107
+ uvx github-milestone-roadmap changes --config roadmap.toml --token "$(gh auth token)"
108
+ ```
109
+
110
+ or set `GITHUB_TOKEN` in the environment. Use `--hours N` to change the
111
+ look-back window.
112
+
113
+ ## Development
114
+
115
+ ```sh
116
+ uv run pytest
117
+ uv run pre-commit install # ruff lint and format on commit
118
+ ```
119
+
120
+ To preview the page locally:
121
+
122
+ ```sh
123
+ uv run github-milestone-roadmap build --config examples/roadmap.toml --output _site
124
+ python3 -m http.server --directory _site 8080
125
+ ```
126
+
127
+ Then visit http://localhost:8080. The page needs `config.json` from the build,
128
+ so opening `index.html` directly from disk will not work.
129
+
130
+ ## Releasing
131
+
132
+ Versions come from git tags (hatch-vcs). To release, update `CHANGELOG.md`,
133
+ merge to `main`, then tag `vX.Y.Z` on `main` and push the tag. The `release`
134
+ workflow publishes to PyPI with trusted publishing.
@@ -0,0 +1,13 @@
1
+ github_milestone_roadmap/__init__.py,sha256=LCEkMohv8-VjfEXlo-nl189WO4nroAgJq0eSjDlLMJk,292
2
+ github_milestone_roadmap/build.py,sha256=jrxNxarHV_NzIRZT_hoKNc26CUXO2H6nprJaqsXqH1c,4763
3
+ github_milestone_roadmap/changes.py,sha256=Zl10kS8NRT6EsnpWT0bAQFPW_ZKYFouzEm30By9liV8,11085
4
+ github_milestone_roadmap/cli.py,sha256=yfQEBIA8hIFSkRm6k29-58tQgqyGhi6vpywFAuaaA2E,3747
5
+ github_milestone_roadmap/config.py,sha256=jVLvTVdT1FFLKxan9Xb9LDe6WPtmUzgfMkzYFgj1eEk,8047
6
+ github_milestone_roadmap/static/app.js,sha256=Jc3Ta3jnv5548wngYxldMGku-pWC_YwrX6Iyen1gWRM,17438
7
+ github_milestone_roadmap/static/index.html,sha256=ABvjidFjlxD-ipGtRwkOgipcTpvA7jB-ovhsriolbP8,1734
8
+ github_milestone_roadmap/static/styles.css,sha256=v2YRDyFhQ9qGnsGdb0E8jqDGjk7AmLiJsjE_gXI_dT8,9247
9
+ github_milestone_roadmap-0.1.0.dist-info/METADATA,sha256=04aAio0rhyAfZWpq5CI8qR9XQ7exrFIVmzpjN-KNub0,4414
10
+ github_milestone_roadmap-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
11
+ github_milestone_roadmap-0.1.0.dist-info/entry_points.txt,sha256=qNZR7U-8obIMXctzqid6N3PquRLbt76o9YlYm2H8mDU,79
12
+ github_milestone_roadmap-0.1.0.dist-info/licenses/LICENSE,sha256=TZosDkAcAwEkCf96EwODREY4tHbePx-NFni-4gFw0F4,1094
13
+ github_milestone_roadmap-0.1.0.dist-info/RECORD,,