backlogops 1.2__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.2 → backlogops-1.4}/PKG-INFO +78 -17
  2. {backlogops-1.2 → backlogops-1.4}/README_pypi.md +72 -11
  3. {backlogops-1.2 → backlogops-1.4}/backlogops.egg-info/PKG-INFO +78 -17
  4. {backlogops-1.2 → backlogops-1.4}/backlogops.egg-info/SOURCES.txt +12 -0
  5. backlogops-1.4/backlogops.egg-info/requires.txt +8 -0
  6. {backlogops-1.2 → backlogops-1.4}/setup.py +6 -6
  7. {backlogops-1.2 → backlogops-1.4}/src/backlogops/__init__.py +45 -18
  8. {backlogops-1.2 → backlogops-1.4}/src/backlogops/available_teams_config.py +5 -0
  9. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog.py +32 -6
  10. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_helpers.py +84 -10
  11. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_ops_config.py +33 -9
  12. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_ops_wizard.py +84 -40
  13. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_releases.py +49 -3
  14. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_releases_io.py +43 -6
  15. {backlogops-1.2 → backlogops-1.4}/src/backlogops/config_descriptions.py +115 -6
  16. {backlogops-1.2 → 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.2 → backlogops-1.4}/src/backlogops/demo_backlog.py +69 -16
  19. backlogops-1.4/src/backlogops/duration_text.py +79 -0
  20. backlogops-1.4/src/backlogops/estimate_ready_date.py +176 -0
  21. backlogops-1.4/src/backlogops/estimate_rt_ready_date.py +156 -0
  22. backlogops-1.4/src/backlogops/estimate_wizard.py +404 -0
  23. {backlogops-1.2 → backlogops-1.4}/src/backlogops/io_config.py +51 -12
  24. {backlogops-1.2 → backlogops-1.4}/src/backlogops/io_preset_wizard.py +7 -10
  25. backlogops-1.4/src/backlogops/jira_field_json.py +117 -0
  26. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_io_config.py +19 -3
  27. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_order_releases.py +9 -8
  28. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_rank_move_keys.py +11 -11
  29. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_read.py +40 -17
  30. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_rename_releases.py +20 -19
  31. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_update_backlog.py +165 -122
  32. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_update_releases.py +13 -13
  33. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_write.py +297 -312
  34. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_write_fields.py +78 -9
  35. backlogops-1.4/src/backlogops/jira_write_format.py +173 -0
  36. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_write_releases.py +16 -15
  37. backlogops-1.4/src/backlogops/jira_write_status.py +136 -0
  38. backlogops-1.4/src/backlogops/jira_write_time.py +124 -0
  39. backlogops-1.4/src/backlogops/jira_write_types.py +154 -0
  40. backlogops-1.4/src/backlogops/level_defaults.py +352 -0
  41. backlogops-1.2/src/backlogops/estimate_ready_date.py → backlogops-1.4/src/backlogops/ready_date_schedule.py +118 -174
  42. backlogops-1.4/src/backlogops/remaining_time_config.py +289 -0
  43. {backlogops-1.2 → backlogops-1.4}/src/backlogops/table_rows.py +93 -9
  44. {backlogops-1.2 → backlogops-1.4}/src/backlogops/team.py +45 -1
  45. backlogops-1.4/src/backlogops/use_story_points.py +77 -0
  46. {backlogops-1.2 → backlogops-1.4}/src/backlogops/wizard_helpers.py +4 -1
  47. {backlogops-1.2 → backlogops-1.4}/src/backlogops/wizard_navigator.py +60 -11
  48. backlogops-1.2/backlogops.egg-info/requires.txt +0 -8
  49. backlogops-1.2/src/backlogops/jira_write_format.py +0 -101
  50. {backlogops-1.2 → backlogops-1.4}/LICENSE.txt +0 -0
  51. {backlogops-1.2 → backlogops-1.4}/backlogops.egg-info/dependency_links.txt +0 -0
  52. {backlogops-1.2 → backlogops-1.4}/backlogops.egg-info/top_level.txt +0 -0
  53. {backlogops-1.2 → backlogops-1.4}/pyproject.toml +0 -0
  54. {backlogops-1.2 → backlogops-1.4}/setup.cfg +0 -0
  55. {backlogops-1.2 → backlogops-1.4}/src/backlogops/apply_format_rules.py +0 -0
  56. {backlogops-1.2 → backlogops-1.4}/src/backlogops/available_teams.py +0 -0
  57. {backlogops-1.2 → backlogops-1.4}/src/backlogops/backlog_in_release_order.py +0 -0
  58. {backlogops-1.2 → backlogops-1.4}/src/backlogops/blo_version_reporter.py +0 -0
  59. {backlogops-1.2 → backlogops-1.4}/src/backlogops/config_editing.py +0 -0
  60. {backlogops-1.2 → backlogops-1.4}/src/backlogops/date_ranges.py +0 -0
  61. {backlogops-1.2 → backlogops-1.4}/src/backlogops/format_rules.py +0 -0
  62. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_connect.py +0 -0
  63. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_rank_backlog.py +0 -0
  64. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_rank_by_keys.py +0 -0
  65. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_search.py +0 -0
  66. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_token.py +0 -0
  67. {backlogops-1.2 → backlogops-1.4}/src/backlogops/jira_wizard.py +0 -0
  68. {backlogops-1.2 → backlogops-1.4}/src/backlogops/key_list_io.py +0 -0
  69. {backlogops-1.2 → backlogops-1.4}/src/backlogops/levels.py +0 -0
  70. {backlogops-1.2 → backlogops-1.4}/src/backlogops/move_keys_first.py +0 -0
  71. {backlogops-1.2 → backlogops-1.4}/src/backlogops/name_list_io.py +0 -0
  72. {backlogops-1.2 → backlogops-1.4}/src/backlogops/no_text_io.py +0 -0
  73. {backlogops-1.2 → backlogops-1.4}/src/backlogops/order_by_dependencies.py +0 -0
  74. {backlogops-1.2 → backlogops-1.4}/src/backlogops/person.py +0 -0
  75. {backlogops-1.2 → backlogops-1.4}/src/backlogops/py.typed +0 -0
  76. {backlogops-1.2 → backlogops-1.4}/src/backlogops/release_backlog_updates.py +0 -0
  77. {backlogops-1.2 → backlogops-1.4}/src/backlogops/release_change_io.py +0 -0
  78. {backlogops-1.2 → backlogops-1.4}/src/backlogops/releases.py +0 -0
  79. {backlogops-1.2 → backlogops-1.4}/src/backlogops/rename_list_io.py +0 -0
  80. {backlogops-1.2 → backlogops-1.4}/src/backlogops/table_create.py +0 -0
  81. {backlogops-1.2 → backlogops-1.4}/src/backlogops/wizard_forms.py +0 -0
  82. {backlogops-1.2 → 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.2
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
29
- Requires-Dist: wizard-ui-bridge[textual]>=1.3
27
+ Requires-Dist: tableio>=1.2
28
+ Requires-Dist: tableio-cfg-json>=1.5
29
+ Requires-Dist: wizard-ui-bridge[textual]>=1.4
30
30
  Requires-Dist: versionreporter>=0.4
31
- Requires-Dist: edit-cfg-json>=0.2.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,14 @@ 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
+
84
+ - Configure what a backlog item that nobody has estimated counts as, per backlog
85
+ item level, so that an unestimated item does not make the estimated dates too
86
+ optimistic.
87
+
80
88
  - Extract backlog keys at given backlog item levels.
81
89
 
82
90
  - Reorder the backlog so that the dependencies are satisfied.
@@ -101,6 +109,9 @@ The following functionality is available in all 3 packages:
101
109
 
102
110
  - Rename columns when reading a file and when writing a file.
103
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
+
104
115
  - Map custom status names in input files to backlog item statuses.
105
116
 
106
117
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -111,7 +122,16 @@ The following functionality is available in all 3 packages:
111
122
  - Migrate an older configuration or preset file to the current file format.
112
123
 
113
124
  - A wizard to create a backlog-ops configuration file with the workforce, named
114
- input and output presets, level names, and status name mapping.
125
+ input and output presets, level names, status name mapping, the guess for
126
+ unestimated items, whether remaining time estimates are also used, how the
127
+ graphical user interface shows the data, and the Jira integration.
128
+
129
+ - An editor showing a whole configuration file or a stand-alone preset file at
130
+ once, folded where it is deep, to change a single value without stepping
131
+ through the wizard.
132
+
133
+ - Encrypt the Jira API token to a pass-phrase-protected file, so that no
134
+ configuration file holds the token in clear text.
115
135
 
116
136
  - Read a backlog and releases from Jira into a backlog and release table.
117
137
 
@@ -130,6 +150,14 @@ The following functionality is available in all 3 packages:
130
150
  - Move backlog items to a chosen anchor in the Jira rank order, following a key
131
151
  list.
132
152
 
153
+ - Report what a Jira operation did not do. Every Jira result opens with what
154
+ Jira refused or what was skipped, so a value that was not written is visible
155
+ without reading the whole listing.
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
+
133
161
  ## The operating model
134
162
 
135
163
  The operating model that most of the functionality is designed for is that the
@@ -138,8 +166,8 @@ are ordered by priority and dependencies to allow the teams to work in the
138
166
  backlog order. Each backlog item and each release may have a planned ready date,
139
167
  that records what has been communicated to the customer. Each backlog item and
140
168
  each release may have an estimated ready date, that is calculated from the
141
- current backlog state, the team velocity, and what we know about the
142
- 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.
143
171
 
144
172
  ## The backlog item fields
145
173
 
@@ -154,7 +182,10 @@ the library:
154
182
 
155
183
  - `title` The title of the backlog item. Required.
156
184
 
157
- - `story_points` The story points of the backlog item. Required.
185
+ - `story_points` The story points of the backlog item. Optional. An item with no
186
+ story points is one that nobody has estimated yet, and what such an item is
187
+ worked with when a completion date is estimated is configured. May be a
188
+ fraction, such as 0.5.
158
189
 
159
190
  - `status` The status of the backlog item. Required.
160
191
 
@@ -171,7 +202,11 @@ the library:
171
202
 
172
203
  - `team` The team responsible for the backlog item. Optional. Must not be empty
173
204
  string. Must be a valid team name. If None the item can be done by any team.
174
- 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.
175
210
 
176
211
  - `depends_on_f2s` The list of keys of the backlog items that must have been
177
212
  finished before the current item can start. May be empty.
@@ -211,7 +246,7 @@ pip install --upgrade backlogops
211
246
 
212
247
  For a better understanding of how to use the library, CLI or GUI, see the user
213
248
  documentation:
214
- [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)
215
250
 
216
251
  ## API documentation
217
252
 
@@ -255,15 +290,19 @@ from backlogops import (
255
290
  ### Reading and writing
256
291
 
257
292
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
258
- 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.
259
296
 
260
297
  - `read_available_teams`, `write_available_teams`: read and write the
261
298
  available-teams workforce on its own.
262
299
 
263
300
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
264
301
  `get_backlog_ops_config`: read, write, and look up the top-level
265
- `BacklogOpsConfig` (workforce, named input and output presets, and the
266
- optional backlog item levels).
302
+ `BacklogOpsConfig` (workforce, named input and output presets, the
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).
267
306
 
268
307
  - `read_key_list`, `write_key_list`: read and write a list of keys.
269
308
 
@@ -295,6 +334,21 @@ from backlogops import (
295
334
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
296
335
  and set planned dates from the estimate.
297
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
+
342
+ - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
343
+ nobody has estimated counts as, and the story points to work any one
344
+ item with. The estimate uses them, so an unestimated item does not
345
+ count as free.
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
+
298
352
  - `estimate_release_dates`, `release_plan_on_estimate`,
299
353
  `adjust_release_content`: estimate and plan release dates, and adjust
300
354
  release content to fit the planned dates.
@@ -321,14 +375,21 @@ from backlogops import (
321
375
  - `JiraIOConfig`, `JiraPreset`: the Jira connection and preset
322
376
  configuration.
323
377
 
378
+ - `format_add_result`, `format_backlog_updates`, `format_release_result`,
379
+ `format_release_updates`, `format_rank_result`, `format_order_result`,
380
+ `format_rename_result`: turn the result of a Jira operation into a
381
+ listing that opens with what Jira refused or what was skipped.
382
+ `report_has_problems` answers whether such a listing reports something
383
+ that did not happen, which is what marks it in a user interface.
384
+
324
385
  For the full set of public names see the API documentation linked above.
325
386
 
326
387
  ## Test summary
327
388
 
328
- - Test result: 2309 passed, 1 deselected in 58s
389
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
329
390
  - No flake8 warnings.
330
391
  - No mypy errors found.
331
392
  - No pylint warnings.
332
393
  - No python layout warnings.
333
- - Built version(s): 1.2
394
+ - Built version(s): 1.4
334
395
  - Build and test using Python 3.14.7
@@ -41,6 +41,14 @@ 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
+
48
+ - Configure what a backlog item that nobody has estimated counts as, per backlog
49
+ item level, so that an unestimated item does not make the estimated dates too
50
+ optimistic.
51
+
44
52
  - Extract backlog keys at given backlog item levels.
45
53
 
46
54
  - Reorder the backlog so that the dependencies are satisfied.
@@ -65,6 +73,9 @@ The following functionality is available in all 3 packages:
65
73
 
66
74
  - Rename columns when reading a file and when writing a file.
67
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
+
68
79
  - Map custom status names in input files to backlog item statuses.
69
80
 
70
81
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -75,7 +86,16 @@ The following functionality is available in all 3 packages:
75
86
  - Migrate an older configuration or preset file to the current file format.
76
87
 
77
88
  - A wizard to create a backlog-ops configuration file with the workforce, named
78
- input and output presets, level names, and status name mapping.
89
+ input and output presets, level names, status name mapping, the guess for
90
+ unestimated items, whether remaining time estimates are also used, how the
91
+ graphical user interface shows the data, and the Jira integration.
92
+
93
+ - An editor showing a whole configuration file or a stand-alone preset file at
94
+ once, folded where it is deep, to change a single value without stepping
95
+ through the wizard.
96
+
97
+ - Encrypt the Jira API token to a pass-phrase-protected file, so that no
98
+ configuration file holds the token in clear text.
79
99
 
80
100
  - Read a backlog and releases from Jira into a backlog and release table.
81
101
 
@@ -94,6 +114,14 @@ The following functionality is available in all 3 packages:
94
114
  - Move backlog items to a chosen anchor in the Jira rank order, following a key
95
115
  list.
96
116
 
117
+ - Report what a Jira operation did not do. Every Jira result opens with what
118
+ Jira refused or what was skipped, so a value that was not written is visible
119
+ without reading the whole listing.
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
+
97
125
  ## The operating model
98
126
 
99
127
  The operating model that most of the functionality is designed for is that the
@@ -102,8 +130,8 @@ are ordered by priority and dependencies to allow the teams to work in the
102
130
  backlog order. Each backlog item and each release may have a planned ready date,
103
131
  that records what has been communicated to the customer. Each backlog item and
104
132
  each release may have an estimated ready date, that is calculated from the
105
- current backlog state, the team velocity, and what we know about the
106
- 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.
107
135
 
108
136
  ## The backlog item fields
109
137
 
@@ -118,7 +146,10 @@ the library:
118
146
 
119
147
  - `title` The title of the backlog item. Required.
120
148
 
121
- - `story_points` The story points of the backlog item. Required.
149
+ - `story_points` The story points of the backlog item. Optional. An item with no
150
+ story points is one that nobody has estimated yet, and what such an item is
151
+ worked with when a completion date is estimated is configured. May be a
152
+ fraction, such as 0.5.
122
153
 
123
154
  - `status` The status of the backlog item. Required.
124
155
 
@@ -135,7 +166,11 @@ the library:
135
166
 
136
167
  - `team` The team responsible for the backlog item. Optional. Must not be empty
137
168
  string. Must be a valid team name. If None the item can be done by any team.
138
- 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.
139
174
 
140
175
  - `depends_on_f2s` The list of keys of the backlog items that must have been
141
176
  finished before the current item can start. May be empty.
@@ -175,7 +210,7 @@ pip install --upgrade backlogops
175
210
 
176
211
  For a better understanding of how to use the library, CLI or GUI, see the user
177
212
  documentation:
178
- [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)
179
214
 
180
215
  ## API documentation
181
216
 
@@ -219,15 +254,19 @@ from backlogops import (
219
254
  ### Reading and writing
220
255
 
221
256
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
222
- 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.
223
260
 
224
261
  - `read_available_teams`, `write_available_teams`: read and write the
225
262
  available-teams workforce on its own.
226
263
 
227
264
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
228
265
  `get_backlog_ops_config`: read, write, and look up the top-level
229
- `BacklogOpsConfig` (workforce, named input and output presets, and the
230
- optional backlog item levels).
266
+ `BacklogOpsConfig` (workforce, named input and output presets, the
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).
231
270
 
232
271
  - `read_key_list`, `write_key_list`: read and write a list of keys.
233
272
 
@@ -259,6 +298,21 @@ from backlogops import (
259
298
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
260
299
  and set planned dates from the estimate.
261
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
+
306
+ - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
307
+ nobody has estimated counts as, and the story points to work any one
308
+ item with. The estimate uses them, so an unestimated item does not
309
+ count as free.
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
+
262
316
  - `estimate_release_dates`, `release_plan_on_estimate`,
263
317
  `adjust_release_content`: estimate and plan release dates, and adjust
264
318
  release content to fit the planned dates.
@@ -285,14 +339,21 @@ from backlogops import (
285
339
  - `JiraIOConfig`, `JiraPreset`: the Jira connection and preset
286
340
  configuration.
287
341
 
342
+ - `format_add_result`, `format_backlog_updates`, `format_release_result`,
343
+ `format_release_updates`, `format_rank_result`, `format_order_result`,
344
+ `format_rename_result`: turn the result of a Jira operation into a
345
+ listing that opens with what Jira refused or what was skipped.
346
+ `report_has_problems` answers whether such a listing reports something
347
+ that did not happen, which is what marks it in a user interface.
348
+
288
349
  For the full set of public names see the API documentation linked above.
289
350
 
290
351
  ## Test summary
291
352
 
292
- - Test result: 2309 passed, 1 deselected in 58s
353
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
293
354
  - No flake8 warnings.
294
355
  - No mypy errors found.
295
356
  - No pylint warnings.
296
357
  - No python layout warnings.
297
- - Built version(s): 1.2
358
+ - Built version(s): 1.4
298
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.2
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
29
- Requires-Dist: wizard-ui-bridge[textual]>=1.3
27
+ Requires-Dist: tableio>=1.2
28
+ Requires-Dist: tableio-cfg-json>=1.5
29
+ Requires-Dist: wizard-ui-bridge[textual]>=1.4
30
30
  Requires-Dist: versionreporter>=0.4
31
- Requires-Dist: edit-cfg-json>=0.2.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,14 @@ 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
+
84
+ - Configure what a backlog item that nobody has estimated counts as, per backlog
85
+ item level, so that an unestimated item does not make the estimated dates too
86
+ optimistic.
87
+
80
88
  - Extract backlog keys at given backlog item levels.
81
89
 
82
90
  - Reorder the backlog so that the dependencies are satisfied.
@@ -101,6 +109,9 @@ The following functionality is available in all 3 packages:
101
109
 
102
110
  - Rename columns when reading a file and when writing a file.
103
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
+
104
115
  - Map custom status names in input files to backlog item statuses.
105
116
 
106
117
  - Choose how backlog item levels are written: by number, by name, or both, and
@@ -111,7 +122,16 @@ The following functionality is available in all 3 packages:
111
122
  - Migrate an older configuration or preset file to the current file format.
112
123
 
113
124
  - A wizard to create a backlog-ops configuration file with the workforce, named
114
- input and output presets, level names, and status name mapping.
125
+ input and output presets, level names, status name mapping, the guess for
126
+ unestimated items, whether remaining time estimates are also used, how the
127
+ graphical user interface shows the data, and the Jira integration.
128
+
129
+ - An editor showing a whole configuration file or a stand-alone preset file at
130
+ once, folded where it is deep, to change a single value without stepping
131
+ through the wizard.
132
+
133
+ - Encrypt the Jira API token to a pass-phrase-protected file, so that no
134
+ configuration file holds the token in clear text.
115
135
 
116
136
  - Read a backlog and releases from Jira into a backlog and release table.
117
137
 
@@ -130,6 +150,14 @@ The following functionality is available in all 3 packages:
130
150
  - Move backlog items to a chosen anchor in the Jira rank order, following a key
131
151
  list.
132
152
 
153
+ - Report what a Jira operation did not do. Every Jira result opens with what
154
+ Jira refused or what was skipped, so a value that was not written is visible
155
+ without reading the whole listing.
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
+
133
161
  ## The operating model
134
162
 
135
163
  The operating model that most of the functionality is designed for is that the
@@ -138,8 +166,8 @@ are ordered by priority and dependencies to allow the teams to work in the
138
166
  backlog order. Each backlog item and each release may have a planned ready date,
139
167
  that records what has been communicated to the customer. Each backlog item and
140
168
  each release may have an estimated ready date, that is calculated from the
141
- current backlog state, the team velocity, and what we know about the
142
- 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.
143
171
 
144
172
  ## The backlog item fields
145
173
 
@@ -154,7 +182,10 @@ the library:
154
182
 
155
183
  - `title` The title of the backlog item. Required.
156
184
 
157
- - `story_points` The story points of the backlog item. Required.
185
+ - `story_points` The story points of the backlog item. Optional. An item with no
186
+ story points is one that nobody has estimated yet, and what such an item is
187
+ worked with when a completion date is estimated is configured. May be a
188
+ fraction, such as 0.5.
158
189
 
159
190
  - `status` The status of the backlog item. Required.
160
191
 
@@ -171,7 +202,11 @@ the library:
171
202
 
172
203
  - `team` The team responsible for the backlog item. Optional. Must not be empty
173
204
  string. Must be a valid team name. If None the item can be done by any team.
174
- 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.
175
210
 
176
211
  - `depends_on_f2s` The list of keys of the backlog items that must have been
177
212
  finished before the current item can start. May be empty.
@@ -211,7 +246,7 @@ pip install --upgrade backlogops
211
246
 
212
247
  For a better understanding of how to use the library, CLI or GUI, see the user
213
248
  documentation:
214
- [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)
215
250
 
216
251
  ## API documentation
217
252
 
@@ -255,15 +290,19 @@ from backlogops import (
255
290
  ### Reading and writing
256
291
 
257
292
  - `read_backlog_releases`, `write_backlog_releases`: read and write a
258
- 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.
259
296
 
260
297
  - `read_available_teams`, `write_available_teams`: read and write the
261
298
  available-teams workforce on its own.
262
299
 
263
300
  - `read_backlog_ops_config`, `write_backlog_ops_config`,
264
301
  `get_backlog_ops_config`: read, write, and look up the top-level
265
- `BacklogOpsConfig` (workforce, named input and output presets, and the
266
- optional backlog item levels).
302
+ `BacklogOpsConfig` (workforce, named input and output presets, the
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).
267
306
 
268
307
  - `read_key_list`, `write_key_list`: read and write a list of keys.
269
308
 
@@ -295,6 +334,21 @@ from backlogops import (
295
334
  - `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
296
335
  and set planned dates from the estimate.
297
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
+
342
+ - `DefaultStoryPoints`, `use_story_points`: what a backlog item that
343
+ nobody has estimated counts as, and the story points to work any one
344
+ item with. The estimate uses them, so an unestimated item does not
345
+ count as free.
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
+
298
352
  - `estimate_release_dates`, `release_plan_on_estimate`,
299
353
  `adjust_release_content`: estimate and plan release dates, and adjust
300
354
  release content to fit the planned dates.
@@ -321,14 +375,21 @@ from backlogops import (
321
375
  - `JiraIOConfig`, `JiraPreset`: the Jira connection and preset
322
376
  configuration.
323
377
 
378
+ - `format_add_result`, `format_backlog_updates`, `format_release_result`,
379
+ `format_release_updates`, `format_rank_result`, `format_order_result`,
380
+ `format_rename_result`: turn the result of a Jira operation into a
381
+ listing that opens with what Jira refused or what was skipped.
382
+ `report_has_problems` answers whether such a listing reports something
383
+ that did not happen, which is what marks it in a user interface.
384
+
324
385
  For the full set of public names see the API documentation linked above.
325
386
 
326
387
  ## Test summary
327
388
 
328
- - Test result: 2309 passed, 1 deselected in 58s
389
+ - Test result: 2902 passed, 1 deselected in 68s (0:01:08)
329
390
  - No flake8 warnings.
330
391
  - No mypy errors found.
331
392
  - No pylint warnings.
332
393
  - No python layout warnings.
333
- - Built version(s): 1.2
394
+ - Built version(s): 1.4
334
395
  - Build and test using Python 3.14.7
@@ -23,12 +23,17 @@ src/backlogops/config_descriptions.py
23
23
  src/backlogops/config_editing.py
24
24
  src/backlogops/config_file_io.py
25
25
  src/backlogops/date_ranges.py
26
+ src/backlogops/default_story_points.py
26
27
  src/backlogops/demo_backlog.py
28
+ src/backlogops/duration_text.py
27
29
  src/backlogops/estimate_ready_date.py
30
+ src/backlogops/estimate_rt_ready_date.py
31
+ src/backlogops/estimate_wizard.py
28
32
  src/backlogops/format_rules.py
29
33
  src/backlogops/io_config.py
30
34
  src/backlogops/io_preset_wizard.py
31
35
  src/backlogops/jira_connect.py
36
+ src/backlogops/jira_field_json.py
32
37
  src/backlogops/jira_io_config.py
33
38
  src/backlogops/jira_order_releases.py
34
39
  src/backlogops/jira_rank_backlog.py
@@ -45,7 +50,11 @@ src/backlogops/jira_write.py
45
50
  src/backlogops/jira_write_fields.py
46
51
  src/backlogops/jira_write_format.py
47
52
  src/backlogops/jira_write_releases.py
53
+ src/backlogops/jira_write_status.py
54
+ src/backlogops/jira_write_time.py
55
+ src/backlogops/jira_write_types.py
48
56
  src/backlogops/key_list_io.py
57
+ src/backlogops/level_defaults.py
49
58
  src/backlogops/levels.py
50
59
  src/backlogops/move_keys_first.py
51
60
  src/backlogops/name_list_io.py
@@ -53,13 +62,16 @@ src/backlogops/no_text_io.py
53
62
  src/backlogops/order_by_dependencies.py
54
63
  src/backlogops/person.py
55
64
  src/backlogops/py.typed
65
+ src/backlogops/ready_date_schedule.py
56
66
  src/backlogops/release_backlog_updates.py
57
67
  src/backlogops/release_change_io.py
58
68
  src/backlogops/releases.py
69
+ src/backlogops/remaining_time_config.py
59
70
  src/backlogops/rename_list_io.py
60
71
  src/backlogops/table_create.py
61
72
  src/backlogops/table_rows.py
62
73
  src/backlogops/team.py
74
+ src/backlogops/use_story_points.py
63
75
  src/backlogops/wizard_forms.py
64
76
  src/backlogops/wizard_helpers.py
65
77
  src/backlogops/wizard_navigator.py
@@ -0,0 +1,8 @@
1
+ config-as-json>=1.7
2
+ cryptography>=50.0.2
3
+ jira[cli,opt]>=3.10.5
4
+ tableio>=1.2
5
+ tableio-cfg-json>=1.5
6
+ wizard-ui-bridge[textual]>=1.4
7
+ versionreporter>=0.4
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.2',
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',
22
- 'wizard-ui-bridge[textual] >= 1.3',
20
+ 'tableio >= 1.2',
21
+ 'tableio-cfg-json >= 1.5',
22
+ 'wizard-ui-bridge[textual] >= 1.4',
23
23
  'versionreporter >= 0.4',
24
- 'edit-cfg-json >= 0.2.0',
24
+ 'edit-cfg-json >= 0.4.0',
25
25
  ]
26
26
  )