backlogops 1.3__tar.gz → 1.4__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 (82) hide show
  1. {backlogops-1.3 → backlogops-1.4}/PKG-INFO +44 -17
  2. {backlogops-1.3 → backlogops-1.4}/README_pypi.md +39 -12
  3. {backlogops-1.3 → backlogops-1.4}/backlogops.egg-info/PKG-INFO +44 -17
  4. {backlogops-1.3 → backlogops-1.4}/backlogops.egg-info/SOURCES.txt +8 -0
  5. {backlogops-1.3 → backlogops-1.4}/backlogops.egg-info/requires.txt +4 -4
  6. {backlogops-1.3 → backlogops-1.4}/setup.py +5 -5
  7. {backlogops-1.3 → backlogops-1.4}/src/backlogops/__init__.py +27 -11
  8. {backlogops-1.3 → backlogops-1.4}/src/backlogops/available_teams_config.py +5 -0
  9. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog.py +25 -4
  10. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_helpers.py +48 -10
  11. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_ops_config.py +21 -8
  12. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_ops_wizard.py +75 -93
  13. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_releases.py +38 -0
  14. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_releases_io.py +43 -6
  15. {backlogops-1.3 → backlogops-1.4}/src/backlogops/config_descriptions.py +82 -9
  16. {backlogops-1.3 → backlogops-1.4}/src/backlogops/config_file_io.py +1 -1
  17. backlogops-1.4/src/backlogops/default_story_points.py +157 -0
  18. backlogops-1.4/src/backlogops/duration_text.py +79 -0
  19. backlogops-1.4/src/backlogops/estimate_ready_date.py +176 -0
  20. backlogops-1.4/src/backlogops/estimate_rt_ready_date.py +156 -0
  21. backlogops-1.4/src/backlogops/estimate_wizard.py +404 -0
  22. {backlogops-1.3 → backlogops-1.4}/src/backlogops/io_config.py +51 -12
  23. {backlogops-1.3 → backlogops-1.4}/src/backlogops/io_preset_wizard.py +7 -10
  24. backlogops-1.4/src/backlogops/jira_field_json.py +117 -0
  25. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_io_config.py +19 -3
  26. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_read.py +35 -5
  27. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_update_backlog.py +47 -32
  28. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write.py +47 -24
  29. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write_fields.py +15 -3
  30. backlogops-1.4/src/backlogops/jira_write_time.py +124 -0
  31. backlogops-1.4/src/backlogops/level_defaults.py +352 -0
  32. backlogops-1.4/src/backlogops/ready_date_schedule.py +325 -0
  33. backlogops-1.4/src/backlogops/remaining_time_config.py +289 -0
  34. {backlogops-1.3 → backlogops-1.4}/src/backlogops/table_rows.py +68 -6
  35. {backlogops-1.3 → backlogops-1.4}/src/backlogops/team.py +45 -1
  36. {backlogops-1.3 → backlogops-1.4}/src/backlogops/use_story_points.py +3 -2
  37. {backlogops-1.3 → backlogops-1.4}/src/backlogops/wizard_helpers.py +4 -110
  38. {backlogops-1.3 → backlogops-1.4}/src/backlogops/wizard_navigator.py +59 -24
  39. backlogops-1.3/src/backlogops/default_story_points.py +0 -371
  40. backlogops-1.3/src/backlogops/estimate_ready_date.py +0 -439
  41. {backlogops-1.3 → backlogops-1.4}/LICENSE.txt +0 -0
  42. {backlogops-1.3 → backlogops-1.4}/backlogops.egg-info/dependency_links.txt +0 -0
  43. {backlogops-1.3 → backlogops-1.4}/backlogops.egg-info/top_level.txt +0 -0
  44. {backlogops-1.3 → backlogops-1.4}/pyproject.toml +0 -0
  45. {backlogops-1.3 → backlogops-1.4}/setup.cfg +0 -0
  46. {backlogops-1.3 → backlogops-1.4}/src/backlogops/apply_format_rules.py +0 -0
  47. {backlogops-1.3 → backlogops-1.4}/src/backlogops/available_teams.py +0 -0
  48. {backlogops-1.3 → backlogops-1.4}/src/backlogops/backlog_in_release_order.py +0 -0
  49. {backlogops-1.3 → backlogops-1.4}/src/backlogops/blo_version_reporter.py +0 -0
  50. {backlogops-1.3 → backlogops-1.4}/src/backlogops/config_editing.py +0 -0
  51. {backlogops-1.3 → backlogops-1.4}/src/backlogops/date_ranges.py +0 -0
  52. {backlogops-1.3 → backlogops-1.4}/src/backlogops/demo_backlog.py +0 -0
  53. {backlogops-1.3 → backlogops-1.4}/src/backlogops/format_rules.py +0 -0
  54. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_connect.py +0 -0
  55. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_order_releases.py +0 -0
  56. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_rank_backlog.py +0 -0
  57. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_rank_by_keys.py +0 -0
  58. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_rank_move_keys.py +0 -0
  59. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_rename_releases.py +0 -0
  60. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_search.py +0 -0
  61. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_token.py +0 -0
  62. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_update_releases.py +0 -0
  63. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_wizard.py +0 -0
  64. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write_format.py +0 -0
  65. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write_releases.py +0 -0
  66. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write_status.py +0 -0
  67. {backlogops-1.3 → backlogops-1.4}/src/backlogops/jira_write_types.py +0 -0
  68. {backlogops-1.3 → backlogops-1.4}/src/backlogops/key_list_io.py +0 -0
  69. {backlogops-1.3 → backlogops-1.4}/src/backlogops/levels.py +0 -0
  70. {backlogops-1.3 → backlogops-1.4}/src/backlogops/move_keys_first.py +0 -0
  71. {backlogops-1.3 → backlogops-1.4}/src/backlogops/name_list_io.py +0 -0
  72. {backlogops-1.3 → backlogops-1.4}/src/backlogops/no_text_io.py +0 -0
  73. {backlogops-1.3 → backlogops-1.4}/src/backlogops/order_by_dependencies.py +0 -0
  74. {backlogops-1.3 → backlogops-1.4}/src/backlogops/person.py +0 -0
  75. {backlogops-1.3 → backlogops-1.4}/src/backlogops/py.typed +0 -0
  76. {backlogops-1.3 → backlogops-1.4}/src/backlogops/release_backlog_updates.py +0 -0
  77. {backlogops-1.3 → backlogops-1.4}/src/backlogops/release_change_io.py +0 -0
  78. {backlogops-1.3 → backlogops-1.4}/src/backlogops/releases.py +0 -0
  79. {backlogops-1.3 → backlogops-1.4}/src/backlogops/rename_list_io.py +0 -0
  80. {backlogops-1.3 → backlogops-1.4}/src/backlogops/table_create.py +0 -0
  81. {backlogops-1.3 → backlogops-1.4}/src/backlogops/wizard_forms.py +0 -0
  82. {backlogops-1.3 → backlogops-1.4}/src/backlogops/work_hours.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: backlogops
3
- Version: 1.3
3
+ Version: 1.4
4
4
  Summary: Library with backlog operations.
5
5
  Author: Tom Björkholm
6
6
  Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -22,13 +22,13 @@ Requires-Python: >=3.12
22
22
  Description-Content-Type: text/markdown
23
23
  License-File: LICENSE.txt
24
24
  Requires-Dist: config-as-json>=1.7
25
- Requires-Dist: cryptography>=50.0.1
25
+ Requires-Dist: cryptography>=50.0.2
26
26
  Requires-Dist: jira[cli,opt]>=3.10.5
27
- Requires-Dist: tableio>=1.1
28
- Requires-Dist: tableio-cfg-json>=1.4
27
+ Requires-Dist: tableio>=1.2
28
+ Requires-Dist: tableio-cfg-json>=1.5
29
29
  Requires-Dist: wizard-ui-bridge[textual]>=1.4
30
30
  Requires-Dist: versionreporter>=0.4
31
- Requires-Dist: edit-cfg-json>=0.3.0
31
+ Requires-Dist: edit-cfg-json>=0.4.0
32
32
  Dynamic: author
33
33
  Dynamic: license-file
34
34
  Dynamic: requires-dist
@@ -77,6 +77,10 @@ The following functionality is available in all 3 packages:
77
77
  - Estimate ready date for the backlog items based on available teams, team
78
78
  velocity, vacation dates, periods with half time work, etc.
79
79
 
80
+ - Alternatively, where remaining time estimates are required, estimate ready
81
+ dates from the remaining time of the backlog items and the focus factor of the
82
+ teams (story points are recommended).
83
+
80
84
  - Configure what a backlog item that nobody has estimated counts as, per backlog
81
85
  item level, so that an unestimated item does not make the estimated dates too
82
86
  optimistic.
@@ -105,6 +109,9 @@ The following functionality is available in all 3 packages:
105
109
 
106
110
  - Rename columns when reading a file and when writing a file.
107
111
 
112
+ - Leave out columns that are empty on every row, when writing a file and when
113
+ showing the backlog in the GUI.
114
+
108
115
  - Map custom status names in input files to backlog item statuses.
109
116
 
110
117
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -116,8 +123,8 @@ The following functionality is available in all 3 packages:
116
123
 
117
124
  - A wizard to create a backlog-ops configuration file with the workforce, named
118
125
  input and output presets, level names, status name mapping, the guess for
119
- unestimated items, how the graphical user interface shows the data, and the
120
- Jira integration.
126
+ unestimated items, whether remaining time estimates are also used, how the
127
+ graphical user interface shows the data, and the Jira integration.
121
128
 
122
129
  - An editor showing a whole configuration file or a stand-alone preset file at
123
130
  once, folded where it is deep, to change a single value without stepping
@@ -147,6 +154,10 @@ The following functionality is available in all 3 packages:
147
154
  Jira refused or what was skipped, so a value that was not written is visible
148
155
  without reading the whole listing.
149
156
 
157
+ - Show the custom fields of Jira, the fields an issue's edit screen accepts, and
158
+ the raw JSON Jira holds for a field of an issue, to find the correct Jira
159
+ field mapping.
160
+
150
161
  ## The operating model
151
162
 
152
163
  The operating model that most of the functionality is designed for is that the
@@ -155,8 +166,8 @@ are ordered by priority and dependencies to allow the teams to work in the
155
166
  backlog order. Each backlog item and each release may have a planned ready date,
156
167
  that records what has been communicated to the customer. Each backlog item and
157
168
  each release may have an estimated ready date, that is calculated from the
158
- current backlog state, the team velocity, and what we know about the
159
- availability of the team members.
169
+ current backlog state, the team velocity (or, for remaining time estimates, the
170
+ focus factor), and what we know about the availability of the team members.
160
171
 
161
172
  ## The backlog item fields
162
173
 
@@ -191,7 +202,11 @@ the library:
191
202
 
192
203
  - `team` The team responsible for the backlog item. Optional. Must not be empty
193
204
  string. Must be a valid team name. If None the item can be done by any team.
194
- If not None. the item can only be done by the specified team.
205
+ If not None, the item can only be done by the specified team.
206
+
207
+ - `remaining_time` The remaining time of the backlog item, as ideal focused work
208
+ time of one person. Optional. Only used by the alternative remaining time
209
+ estimates; story points are recommended. Must not be negative.
195
210
 
196
211
  - `depends_on_f2s` The list of keys of the backlog items that must have been
197
212
  finished before the current item can start. May be empty.
@@ -231,7 +246,7 @@ pip install --upgrade backlogops
231
246
 
232
247
  For a better understanding of how to use the library, CLI or GUI, see the user
233
248
  documentation:
234
- [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
249
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md)
235
250
 
236
251
  ## API documentation
237
252
 
@@ -275,7 +290,9 @@ from backlogops import (
275
290
  ### Reading and writing
276
291
 
277
292
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
278
- backlog and its releases from and to a table file.
293
+ backlog and its releases from and to a table file, including the
294
+ remaining time of each item, and leaving out columns that are empty
295
+ on every row when the output preset asks for it.
279
296
 
280
297
  - `read_available_teams`, `write_available_teams`: read and write the
281
298
  available-teams workforce on its own.
@@ -283,9 +300,9 @@ from backlogops import (
283
300
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
284
301
  `get_backlog_ops_config`: read, write, and look up the top-level
285
302
  `BacklogOpsConfig` (workforce, named input and output presets, the
286
- status-name map, the guess for unestimated items, the GUI display
287
- settings, the Jira configuration, and the optional backlog item
288
- levels).
303
+ status-name map, the guess for unestimated items, whether remaining
304
+ time estimates are also used, the GUI display settings, the Jira
305
+ configuration, and the optional backlog item levels).
289
306
 
290
307
  - `read_key_list`, `write_key_list`: read and write a list of keys.
291
308
 
@@ -317,11 +334,21 @@ from backlogops import (
317
334
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
318
335
  and set planned dates from the estimate.
319
336
 
337
+ - `estimate_rt_ready_date`, `FeatureDisabled`: estimate ready dates from
338
+ remaining time and the focus factor of the teams instead of from story
339
+ points, refused with `FeatureDisabled` unless remaining time estimates
340
+ are enabled.
341
+
320
342
  - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
321
343
  nobody has estimated counts as, and the story points to work any one
322
344
  item with. The estimate uses them, so an unestimated item does not
323
345
  count as free.
324
346
 
347
+ - `RemainingTimeConfig`, `parse_duration`, `format_duration`: whether
348
+ remaining time estimates are also used beside story points (story
349
+ points are recommended), with the focus factor and the guess for
350
+ unestimated items, and a remaining time read from and written as text.
351
+
325
352
  - `estimate_release_dates`, `release_plan_on_estimate`,
326
353
  `adjust_release_content`: estimate and plan release dates, and adjust
327
354
  release content to fit the planned dates.
@@ -359,10 +386,10 @@ For the full set of public names see the API documentation linked above.
359
386
 
360
387
  ## Test summary
361
388
 
362
- - Test result: 2555 passed, 1 deselected in 58s
389
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
363
390
  - No flake8 warnings.
364
391
  - No mypy errors found.
365
392
  - No pylint warnings.
366
393
  - No python layout warnings.
367
- - Built version(s): 1.3
394
+ - Built version(s): 1.4
368
395
  - Build and test using Python 3.14.7
@@ -41,6 +41,10 @@ The following functionality is available in all 3 packages:
41
41
  - Estimate ready date for the backlog items based on available teams, team
42
42
  velocity, vacation dates, periods with half time work, etc.
43
43
 
44
+ - Alternatively, where remaining time estimates are required, estimate ready
45
+ dates from the remaining time of the backlog items and the focus factor of the
46
+ teams (story points are recommended).
47
+
44
48
  - Configure what a backlog item that nobody has estimated counts as, per backlog
45
49
  item level, so that an unestimated item does not make the estimated dates too
46
50
  optimistic.
@@ -69,6 +73,9 @@ The following functionality is available in all 3 packages:
69
73
 
70
74
  - Rename columns when reading a file and when writing a file.
71
75
 
76
+ - Leave out columns that are empty on every row, when writing a file and when
77
+ showing the backlog in the GUI.
78
+
72
79
  - Map custom status names in input files to backlog item statuses.
73
80
 
74
81
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -80,8 +87,8 @@ The following functionality is available in all 3 packages:
80
87
 
81
88
  - A wizard to create a backlog-ops configuration file with the workforce, named
82
89
  input and output presets, level names, status name mapping, the guess for
83
- unestimated items, how the graphical user interface shows the data, and the
84
- Jira integration.
90
+ unestimated items, whether remaining time estimates are also used, how the
91
+ graphical user interface shows the data, and the Jira integration.
85
92
 
86
93
  - An editor showing a whole configuration file or a stand-alone preset file at
87
94
  once, folded where it is deep, to change a single value without stepping
@@ -111,6 +118,10 @@ The following functionality is available in all 3 packages:
111
118
  Jira refused or what was skipped, so a value that was not written is visible
112
119
  without reading the whole listing.
113
120
 
121
+ - Show the custom fields of Jira, the fields an issue's edit screen accepts, and
122
+ the raw JSON Jira holds for a field of an issue, to find the correct Jira
123
+ field mapping.
124
+
114
125
  ## The operating model
115
126
 
116
127
  The operating model that most of the functionality is designed for is that the
@@ -119,8 +130,8 @@ are ordered by priority and dependencies to allow the teams to work in the
119
130
  backlog order. Each backlog item and each release may have a planned ready date,
120
131
  that records what has been communicated to the customer. Each backlog item and
121
132
  each release may have an estimated ready date, that is calculated from the
122
- current backlog state, the team velocity, and what we know about the
123
- availability of the team members.
133
+ current backlog state, the team velocity (or, for remaining time estimates, the
134
+ focus factor), and what we know about the availability of the team members.
124
135
 
125
136
  ## The backlog item fields
126
137
 
@@ -155,7 +166,11 @@ the library:
155
166
 
156
167
  - `team` The team responsible for the backlog item. Optional. Must not be empty
157
168
  string. Must be a valid team name. If None the item can be done by any team.
158
- If not None. the item can only be done by the specified team.
169
+ If not None, the item can only be done by the specified team.
170
+
171
+ - `remaining_time` The remaining time of the backlog item, as ideal focused work
172
+ time of one person. Optional. Only used by the alternative remaining time
173
+ estimates; story points are recommended. Must not be negative.
159
174
 
160
175
  - `depends_on_f2s` The list of keys of the backlog items that must have been
161
176
  finished before the current item can start. May be empty.
@@ -195,7 +210,7 @@ pip install --upgrade backlogops
195
210
 
196
211
  For a better understanding of how to use the library, CLI or GUI, see the user
197
212
  documentation:
198
- [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
213
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md)
199
214
 
200
215
  ## API documentation
201
216
 
@@ -239,7 +254,9 @@ from backlogops import (
239
254
  ### Reading and writing
240
255
 
241
256
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
242
- backlog and its releases from and to a table file.
257
+ backlog and its releases from and to a table file, including the
258
+ remaining time of each item, and leaving out columns that are empty
259
+ on every row when the output preset asks for it.
243
260
 
244
261
  - `read_available_teams`, `write_available_teams`: read and write the
245
262
  available-teams workforce on its own.
@@ -247,9 +264,9 @@ from backlogops import (
247
264
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
248
265
  `get_backlog_ops_config`: read, write, and look up the top-level
249
266
  `BacklogOpsConfig` (workforce, named input and output presets, the
250
- status-name map, the guess for unestimated items, the GUI display
251
- settings, the Jira configuration, and the optional backlog item
252
- levels).
267
+ status-name map, the guess for unestimated items, whether remaining
268
+ time estimates are also used, the GUI display settings, the Jira
269
+ configuration, and the optional backlog item levels).
253
270
 
254
271
  - `read_key_list`, `write_key_list`: read and write a list of keys.
255
272
 
@@ -281,11 +298,21 @@ from backlogops import (
281
298
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
282
299
  and set planned dates from the estimate.
283
300
 
301
+ - `estimate_rt_ready_date`, `FeatureDisabled`: estimate ready dates from
302
+ remaining time and the focus factor of the teams instead of from story
303
+ points, refused with `FeatureDisabled` unless remaining time estimates
304
+ are enabled.
305
+
284
306
  - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
285
307
  nobody has estimated counts as, and the story points to work any one
286
308
  item with. The estimate uses them, so an unestimated item does not
287
309
  count as free.
288
310
 
311
+ - `RemainingTimeConfig`, `parse_duration`, `format_duration`: whether
312
+ remaining time estimates are also used beside story points (story
313
+ points are recommended), with the focus factor and the guess for
314
+ unestimated items, and a remaining time read from and written as text.
315
+
289
316
  - `estimate_release_dates`, `release_plan_on_estimate`,
290
317
  `adjust_release_content`: estimate and plan release dates, and adjust
291
318
  release content to fit the planned dates.
@@ -323,10 +350,10 @@ For the full set of public names see the API documentation linked above.
323
350
 
324
351
  ## Test summary
325
352
 
326
- - Test result: 2555 passed, 1 deselected in 58s
353
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
327
354
  - No flake8 warnings.
328
355
  - No mypy errors found.
329
356
  - No pylint warnings.
330
357
  - No python layout warnings.
331
- - Built version(s): 1.3
358
+ - Built version(s): 1.4
332
359
  - Build and test using Python 3.14.7
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: backlogops
3
- Version: 1.3
3
+ Version: 1.4
4
4
  Summary: Library with backlog operations.
5
5
  Author: Tom Björkholm
6
6
  Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -22,13 +22,13 @@ Requires-Python: >=3.12
22
22
  Description-Content-Type: text/markdown
23
23
  License-File: LICENSE.txt
24
24
  Requires-Dist: config-as-json>=1.7
25
- Requires-Dist: cryptography>=50.0.1
25
+ Requires-Dist: cryptography>=50.0.2
26
26
  Requires-Dist: jira[cli,opt]>=3.10.5
27
- Requires-Dist: tableio>=1.1
28
- Requires-Dist: tableio-cfg-json>=1.4
27
+ Requires-Dist: tableio>=1.2
28
+ Requires-Dist: tableio-cfg-json>=1.5
29
29
  Requires-Dist: wizard-ui-bridge[textual]>=1.4
30
30
  Requires-Dist: versionreporter>=0.4
31
- Requires-Dist: edit-cfg-json>=0.3.0
31
+ Requires-Dist: edit-cfg-json>=0.4.0
32
32
  Dynamic: author
33
33
  Dynamic: license-file
34
34
  Dynamic: requires-dist
@@ -77,6 +77,10 @@ The following functionality is available in all 3 packages:
77
77
  - Estimate ready date for the backlog items based on available teams, team
78
78
  velocity, vacation dates, periods with half time work, etc.
79
79
 
80
+ - Alternatively, where remaining time estimates are required, estimate ready
81
+ dates from the remaining time of the backlog items and the focus factor of the
82
+ teams (story points are recommended).
83
+
80
84
  - Configure what a backlog item that nobody has estimated counts as, per backlog
81
85
  item level, so that an unestimated item does not make the estimated dates too
82
86
  optimistic.
@@ -105,6 +109,9 @@ The following functionality is available in all 3 packages:
105
109
 
106
110
  - Rename columns when reading a file and when writing a file.
107
111
 
112
+ - Leave out columns that are empty on every row, when writing a file and when
113
+ showing the backlog in the GUI.
114
+
108
115
  - Map custom status names in input files to backlog item statuses.
109
116
 
110
117
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -116,8 +123,8 @@ The following functionality is available in all 3 packages:
116
123
 
117
124
  - A wizard to create a backlog-ops configuration file with the workforce, named
118
125
  input and output presets, level names, status name mapping, the guess for
119
- unestimated items, how the graphical user interface shows the data, and the
120
- Jira integration.
126
+ unestimated items, whether remaining time estimates are also used, how the
127
+ graphical user interface shows the data, and the Jira integration.
121
128
 
122
129
  - An editor showing a whole configuration file or a stand-alone preset file at
123
130
  once, folded where it is deep, to change a single value without stepping
@@ -147,6 +154,10 @@ The following functionality is available in all 3 packages:
147
154
  Jira refused or what was skipped, so a value that was not written is visible
148
155
  without reading the whole listing.
149
156
 
157
+ - Show the custom fields of Jira, the fields an issue's edit screen accepts, and
158
+ the raw JSON Jira holds for a field of an issue, to find the correct Jira
159
+ field mapping.
160
+
150
161
  ## The operating model
151
162
 
152
163
  The operating model that most of the functionality is designed for is that the
@@ -155,8 +166,8 @@ are ordered by priority and dependencies to allow the teams to work in the
155
166
  backlog order. Each backlog item and each release may have a planned ready date,
156
167
  that records what has been communicated to the customer. Each backlog item and
157
168
  each release may have an estimated ready date, that is calculated from the
158
- current backlog state, the team velocity, and what we know about the
159
- availability of the team members.
169
+ current backlog state, the team velocity (or, for remaining time estimates, the
170
+ focus factor), and what we know about the availability of the team members.
160
171
 
161
172
  ## The backlog item fields
162
173
 
@@ -191,7 +202,11 @@ the library:
191
202
 
192
203
  - `team` The team responsible for the backlog item. Optional. Must not be empty
193
204
  string. Must be a valid team name. If None the item can be done by any team.
194
- If not None. the item can only be done by the specified team.
205
+ If not None, the item can only be done by the specified team.
206
+
207
+ - `remaining_time` The remaining time of the backlog item, as ideal focused work
208
+ time of one person. Optional. Only used by the alternative remaining time
209
+ estimates; story points are recommended. Must not be negative.
195
210
 
196
211
  - `depends_on_f2s` The list of keys of the backlog items that must have been
197
212
  finished before the current item can start. May be empty.
@@ -231,7 +246,7 @@ pip install --upgrade backlogops
231
246
 
232
247
  For a better understanding of how to use the library, CLI or GUI, see the user
233
248
  documentation:
234
- [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
249
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md)
235
250
 
236
251
  ## API documentation
237
252
 
@@ -275,7 +290,9 @@ from backlogops import (
275
290
  ### Reading and writing
276
291
 
277
292
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
278
- backlog and its releases from and to a table file.
293
+ backlog and its releases from and to a table file, including the
294
+ remaining time of each item, and leaving out columns that are empty
295
+ on every row when the output preset asks for it.
279
296
 
280
297
  - `read_available_teams`, `write_available_teams`: read and write the
281
298
  available-teams workforce on its own.
@@ -283,9 +300,9 @@ from backlogops import (
283
300
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
284
301
  `get_backlog_ops_config`: read, write, and look up the top-level
285
302
  `BacklogOpsConfig` (workforce, named input and output presets, the
286
- status-name map, the guess for unestimated items, the GUI display
287
- settings, the Jira configuration, and the optional backlog item
288
- levels).
303
+ status-name map, the guess for unestimated items, whether remaining
304
+ time estimates are also used, the GUI display settings, the Jira
305
+ configuration, and the optional backlog item levels).
289
306
 
290
307
  - `read_key_list`, `write_key_list`: read and write a list of keys.
291
308
 
@@ -317,11 +334,21 @@ from backlogops import (
317
334
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
318
335
  and set planned dates from the estimate.
319
336
 
337
+ - `estimate_rt_ready_date`, `FeatureDisabled`: estimate ready dates from
338
+ remaining time and the focus factor of the teams instead of from story
339
+ points, refused with `FeatureDisabled` unless remaining time estimates
340
+ are enabled.
341
+
320
342
  - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
321
343
  nobody has estimated counts as, and the story points to work any one
322
344
  item with. The estimate uses them, so an unestimated item does not
323
345
  count as free.
324
346
 
347
+ - `RemainingTimeConfig`, `parse_duration`, `format_duration`: whether
348
+ remaining time estimates are also used beside story points (story
349
+ points are recommended), with the focus factor and the guess for
350
+ unestimated items, and a remaining time read from and written as text.
351
+
325
352
  - `estimate_release_dates`, `release_plan_on_estimate`,
326
353
  `adjust_release_content`: estimate and plan release dates, and adjust
327
354
  release content to fit the planned dates.
@@ -359,10 +386,10 @@ For the full set of public names see the API documentation linked above.
359
386
 
360
387
  ## Test summary
361
388
 
362
- - Test result: 2555 passed, 1 deselected in 58s
389
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
363
390
  - No flake8 warnings.
364
391
  - No mypy errors found.
365
392
  - No pylint warnings.
366
393
  - No python layout warnings.
367
- - Built version(s): 1.3
394
+ - Built version(s): 1.4
368
395
  - Build and test using Python 3.14.7
@@ -25,11 +25,15 @@ src/backlogops/config_file_io.py
25
25
  src/backlogops/date_ranges.py
26
26
  src/backlogops/default_story_points.py
27
27
  src/backlogops/demo_backlog.py
28
+ src/backlogops/duration_text.py
28
29
  src/backlogops/estimate_ready_date.py
30
+ src/backlogops/estimate_rt_ready_date.py
31
+ src/backlogops/estimate_wizard.py
29
32
  src/backlogops/format_rules.py
30
33
  src/backlogops/io_config.py
31
34
  src/backlogops/io_preset_wizard.py
32
35
  src/backlogops/jira_connect.py
36
+ src/backlogops/jira_field_json.py
33
37
  src/backlogops/jira_io_config.py
34
38
  src/backlogops/jira_order_releases.py
35
39
  src/backlogops/jira_rank_backlog.py
@@ -47,8 +51,10 @@ src/backlogops/jira_write_fields.py
47
51
  src/backlogops/jira_write_format.py
48
52
  src/backlogops/jira_write_releases.py
49
53
  src/backlogops/jira_write_status.py
54
+ src/backlogops/jira_write_time.py
50
55
  src/backlogops/jira_write_types.py
51
56
  src/backlogops/key_list_io.py
57
+ src/backlogops/level_defaults.py
52
58
  src/backlogops/levels.py
53
59
  src/backlogops/move_keys_first.py
54
60
  src/backlogops/name_list_io.py
@@ -56,9 +62,11 @@ src/backlogops/no_text_io.py
56
62
  src/backlogops/order_by_dependencies.py
57
63
  src/backlogops/person.py
58
64
  src/backlogops/py.typed
65
+ src/backlogops/ready_date_schedule.py
59
66
  src/backlogops/release_backlog_updates.py
60
67
  src/backlogops/release_change_io.py
61
68
  src/backlogops/releases.py
69
+ src/backlogops/remaining_time_config.py
62
70
  src/backlogops/rename_list_io.py
63
71
  src/backlogops/table_create.py
64
72
  src/backlogops/table_rows.py
@@ -1,8 +1,8 @@
1
1
  config-as-json>=1.7
2
- cryptography>=50.0.1
2
+ cryptography>=50.0.2
3
3
  jira[cli,opt]>=3.10.5
4
- tableio>=1.1
5
- tableio-cfg-json>=1.4
4
+ tableio>=1.2
5
+ tableio-cfg-json>=1.5
6
6
  wizard-ui-bridge[textual]>=1.4
7
7
  versionreporter>=0.4
8
- edit-cfg-json>=0.3.0
8
+ edit-cfg-json>=0.4.0
@@ -5,7 +5,7 @@ from setuptools import setup
5
5
 
6
6
  setup(
7
7
  name='backlogops',
8
- version='1.3',
8
+ version='1.4',
9
9
  description='Library with backlog operations.',
10
10
  author='Tom Björkholm',
11
11
  author_email='klausuler_linnet0q@icloud.com',
@@ -15,12 +15,12 @@ setup(
15
15
  package_data={'backlogops': ['src/py.typed']},
16
16
  install_requires=[
17
17
  'config-as-json >= 1.7',
18
- 'cryptography >= 50.0.1',
18
+ 'cryptography >= 50.0.2',
19
19
  'jira[cli,opt] >= 3.10.5',
20
- 'tableio >= 1.1',
21
- 'tableio-cfg-json >= 1.4',
20
+ 'tableio >= 1.2',
21
+ 'tableio-cfg-json >= 1.5',
22
22
  'wizard-ui-bridge[textual] >= 1.4',
23
23
  'versionreporter >= 0.4',
24
- 'edit-cfg-json >= 0.3.0',
24
+ 'edit-cfg-json >= 0.4.0',
25
25
  ]
26
26
  )
@@ -39,14 +39,18 @@ from backlogops.date_ranges import check_date_range, check_no_overlap
39
39
  from backlogops.default_story_points import (
40
40
  DefaultStoryPointLevel, DefaultStoryPoints)
41
41
  from backlogops.demo_backlog import get_demo_backlog
42
+ from backlogops.duration_text import format_duration, parse_duration
42
43
  from backlogops.estimate_ready_date import (
43
44
  estimate_ready_date, set_plan_from_estimate)
45
+ from backlogops.estimate_rt_ready_date import (
46
+ FeatureDisabled, estimate_rt_ready_date)
44
47
  from backlogops.format_rules import FormatRules
45
48
  from backlogops.io_config import (
46
49
  GuiDisplayConfig, InputFormatConfig, OutputFormatConfig, make_input_config,
47
50
  make_output_config, resolve_input_config, resolve_output_config)
48
51
  from backlogops.io_preset_wizard import preset_wizard
49
52
  from backlogops.jira_connect import JiraConnections
53
+ from backlogops.jira_field_json import JiraFieldJson, jira_field_json
50
54
  from backlogops.jira_io_config import (
51
55
  CLEAR_TOKEN_WARNING, DEF_BACKLOG_COLUMN_MAP, DEF_RELEASE_COLUMN_MAP,
52
56
  JiraAttrPath, JiraAttrType, JiraColumnMap, JiraConnectConfig, JiraIOConfig,
@@ -103,11 +107,14 @@ from backlogops.release_change_io import (
103
107
  format_content_changes, format_date_changes, write_content_changes,
104
108
  write_date_changes)
105
109
  from backlogops.releases import Release, Releases, get_release, get_releases
110
+ from backlogops.remaining_time_config import (
111
+ DefaultRemainingTimeLevel, RemainingTimeConfig)
106
112
  from backlogops.rename_list_io import read_renames
107
113
  from backlogops.table_create import FileExistsCb, allow_overwrite
108
114
  from backlogops.table_rows import (
109
- LEVEL_COLUMN, LEVEL_NAME_COLUMN, apply_column_map, display_level_order,
110
- display_level_rows, fold_level_name, item_to_row, map_column_order,
115
+ LEVEL_COLUMN, LEVEL_NAME_COLUMN, REMAINING_TIME_COLUMN, apply_column_map,
116
+ display_level_order, display_level_rows, drop_empty_columns,
117
+ fold_level_name, item_to_row, map_column_order, omittable_columns,
111
118
  release_to_row, row_to_item, row_to_release)
112
119
  from backlogops.team import FteException, Membership, Team
113
120
  from backlogops.use_story_points import find_keys_with_children, \
@@ -123,24 +130,28 @@ __all__ = [
123
130
  'CLEAR_TOKEN_WARNING', 'CONFIG_DESCRIPTIONS', 'CONFIG_EXTENSION',
124
131
  'CompanyWorkHours', 'DEFAULT_LEVELS',
125
132
  'DEFAULT_WORK_WEEK', 'DEF_BACKLOG_COLUMN_MAP', 'DEF_RELEASE_COLUMN_MAP',
126
- 'DEF_STATUS_INPUT_MAP', 'DefaultStoryPointLevel', 'DefaultStoryPoints',
133
+ 'DEF_STATUS_INPUT_MAP', 'DefaultRemainingTimeLevel',
134
+ 'DefaultStoryPointLevel', 'DefaultStoryPoints',
127
135
  'DependencyMode', 'EDIT_SETTINGS',
128
136
  'ExceptionWorkHours',
129
137
  'ExistsInJiraError', 'FailedField', 'FailedItem', 'FailedLink',
130
138
  'FailedRelease',
131
- 'FailedRename', 'FileExistsCb', 'FormatRules', 'FteException',
139
+ 'FailedRename', 'FeatureDisabled', 'FileExistsCb', 'FormatRules',
140
+ 'FteException',
132
141
  'GUI_DESCRIPTIONS', 'GuiDisplayConfig', 'INPUT_DESCRIPTIONS',
133
142
  'InputFormatConfig', 'ItemNotInJiraError', 'JIRA_DESCRIPTIONS',
134
143
  'JiraAttrPath', 'JiraAttrType', 'JiraColumnMap', 'JiraConnectConfig',
135
- 'JiraConnections', 'JiraIOConfig', 'JiraIssueTypeMap', 'JiraKeyError',
144
+ 'JiraConnections', 'JiraFieldJson', 'JiraIOConfig', 'JiraIssueTypeMap',
145
+ 'JiraKeyError',
136
146
  'JiraPreset', 'JiraRankAnchor', 'JiraTooManyLoops', 'JiraType',
137
147
  'LEVEL_COLUMN', 'LEVEL_NAME_COLUMN', 'Level', 'LevelDisplay', 'Levels',
138
148
  'LinkUpdate', 'Membership', 'NoTextIO', 'OUTPUT_DESCRIPTIONS',
139
- 'OnExistingKey', 'OnMissingKey',
149
+ 'OnExistingKey', 'OnMissingKey', 'REMAINING_TIME_COLUMN',
140
150
  'OrderedReleasesInJira', 'OutputFormatConfig', 'Person', 'RankedInJira',
141
151
  'Release', 'ReleaseChange', 'ReleaseChanges', 'ReleaseDateChange',
142
152
  'ReleaseDateChanges', 'ReleaseExistsError', 'ReleaseRename', 'Releases',
143
- 'ReleasesAndDateChanges', 'RenamedReleasesInJira', 'ScheduleWorkHours',
153
+ 'ReleasesAndDateChanges', 'RemainingTimeConfig', 'RenamedReleasesInJira',
154
+ 'ScheduleWorkHours',
144
155
  'Status', 'StatusMismatch', 'Team', 'TokenStorage',
145
156
  'UnknownIssueTypeError', 'UpdatedBacklogInJira', 'UpdatedReleasesInJira',
146
157
  'WORKFORCE_DESCRIPTIONS',
@@ -151,12 +162,14 @@ __all__ = [
151
162
  'check_backlog_consistency', 'check_date_range',
152
163
  'check_levels_consistency', 'check_no_overlap',
153
164
  'default_jira_filter', 'descriptions_for',
154
- 'display_level_order', 'display_level_rows',
165
+ 'display_level_order', 'display_level_rows', 'drop_empty_columns',
155
166
  'encrypt_token_file',
156
167
  'encrypt_token_to_file', 'estimate_ready_date', 'estimate_release_dates',
168
+ 'estimate_rt_ready_date',
157
169
  'event_finish', 'event_start', 'find_cycle', 'find_keys_with_children',
158
170
  'fold_level_name',
159
171
  'format_add_result', 'format_backlog', 'format_backlog_updates',
172
+ 'format_duration',
160
173
  'format_content_changes', 'format_date_changes', 'format_order_result',
161
174
  'format_rank_result', 'format_release_result', 'format_release_updates',
162
175
  'format_releases', 'format_rename_result', 'get_backlog',
@@ -164,11 +177,14 @@ __all__ = [
164
177
  'get_keys_in_order', 'get_release', 'get_releases',
165
178
  'io_preset_class', 'item_dependency_edges', 'item_to_row',
166
179
  'jira_custom_fields',
167
- 'jira_editable_fields', 'jira_rank_backlog', 'jira_rank_by_keys_raw',
180
+ 'jira_editable_fields', 'jira_field_json', 'jira_rank_backlog',
181
+ 'jira_rank_by_keys_raw',
168
182
  'jira_rank_move_keys', 'level_name', 'level_number_from_name',
169
183
  'levels_from_list', 'make_input_config', 'make_output_config',
170
- 'map_column_order', 'move_keys_first', 'order_by_dependencies',
171
- 'order_jira_rel_by_date', 'order_releases_in_jira', 'precedence_relations',
184
+ 'map_column_order', 'move_keys_first', 'omittable_columns',
185
+ 'order_by_dependencies',
186
+ 'order_jira_rel_by_date', 'order_releases_in_jira', 'parse_duration',
187
+ 'precedence_relations',
172
188
  'preset_wizard', 'read_available_teams', 'read_backlog_from_jira',
173
189
  'read_backlog_ops_config', 'read_backlog_releases', 'read_io_preset',
174
190
  'read_jira_from_config', 'read_key_list', 'read_name_list', 'read_renames',
@@ -262,6 +262,11 @@ class TeamConfig(Team, _BridgeConfig):
262
262
  return {'members': ConfigNesting(kind=ConfigNestingKind.LIST_ELEMENT,
263
263
  config_type=MembershipConfig)}
264
264
 
265
+ @override
266
+ def _omit_none_from_json(self) -> list[str]:
267
+ """Leave out the focus factor while the default one is used."""
268
+ return ['focus_factor']
269
+
265
270
  @override
266
271
  def get_validation_plan(self, stderr_file: TextIO) -> ValidationPlan:
267
272
  """Check the team consistency."""