backlogops-cli 0.2__tar.gz → 0.3__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 (43) hide show
  1. {backlogops_cli-0.2/backlogops_cli.egg-info → backlogops_cli-0.3}/PKG-INFO +69 -17
  2. backlogops_cli-0.2/PKG-INFO → backlogops_cli-0.3/README_pypi.md +61 -43
  3. backlogops_cli-0.2/README_pypi.md → backlogops_cli-0.3/backlogops_cli.egg-info/PKG-INFO +95 -10
  4. {backlogops_cli-0.2 → backlogops_cli-0.3}/backlogops_cli.egg-info/SOURCES.txt +9 -0
  5. backlogops_cli-0.3/backlogops_cli.egg-info/requires.txt +3 -0
  6. {backlogops_cli-0.2 → backlogops_cli-0.3}/pyproject.toml +6 -5
  7. {backlogops_cli-0.2 → backlogops_cli-0.3}/setup.py +4 -4
  8. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/_command_io.py +43 -9
  9. backlogops_cli-0.3/src/backlogops_cli/add_releases_to_jira.py +144 -0
  10. backlogops_cli-0.3/src/backlogops_cli/add_to_jira.py +151 -0
  11. backlogops_cli-0.3/src/backlogops_cli/jira_fields.py +91 -0
  12. backlogops_cli-0.3/src/backlogops_cli/order_releases_in_jira.py +128 -0
  13. backlogops_cli-0.3/src/backlogops_cli/rank_in_jira.py +120 -0
  14. backlogops_cli-0.3/src/backlogops_cli/read_jira.py +92 -0
  15. backlogops_cli-0.3/src/backlogops_cli/rename_releases_in_jira.py +120 -0
  16. backlogops_cli-0.3/src/backlogops_cli/update_backlog_in_jira.py +177 -0
  17. backlogops_cli-0.3/src/backlogops_cli/update_releases_in_jira.py +135 -0
  18. backlogops_cli-0.2/backlogops_cli.egg-info/requires.txt +0 -3
  19. {backlogops_cli-0.2 → backlogops_cli-0.3}/LICENSE.txt +0 -0
  20. {backlogops_cli-0.2 → backlogops_cli-0.3}/backlogops_cli.egg-info/dependency_links.txt +0 -0
  21. {backlogops_cli-0.2 → backlogops_cli-0.3}/backlogops_cli.egg-info/top_level.txt +0 -0
  22. {backlogops_cli-0.2 → backlogops_cli-0.3}/setup.cfg +0 -0
  23. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/__init__.py +0 -0
  24. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/__main__.py +0 -0
  25. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/_migrate_warn.py +0 -0
  26. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/_wizard_io.py +0 -0
  27. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/adjust_release_content.py +0 -0
  28. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/bloc_version_reporter.py +0 -0
  29. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/config_wizard.py +0 -0
  30. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/convert.py +0 -0
  31. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/demo_backlog.py +0 -0
  32. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/estimate_ready_date.py +0 -0
  33. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/extract_keys.py +0 -0
  34. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/list.py +0 -0
  35. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/migrate_cfg.py +0 -0
  36. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/order_by_deps.py +0 -0
  37. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/order_by_keys.py +0 -0
  38. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/order_by_release.py +0 -0
  39. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/order_releases.py +0 -0
  40. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/plan_release_dates.py +0 -0
  41. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/preset_wizard.py +0 -0
  42. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/py.typed +0 -0
  43. {backlogops_cli-0.2 → backlogops_cli-0.3}/src/backlogops_cli/version.py +0 -0
@@ -1,13 +1,13 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: backlogops-cli
3
- Version: 0.2
3
+ Version: 0.3
4
4
  Summary: Command line interface for backlog operations.
5
5
  Author: Tom Björkholm
6
6
  Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
7
7
  License-Expression: MIT
8
- Project-URL: Homepage, https://bitbucket.org/tom-bjorkholm/backlog-ops
9
- Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/backlog-ops
10
- Project-URL: Documentation, https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/
8
+ Project-URL: Homepage, https://github.com/tom-bjorkholm/backlog-ops
9
+ Project-URL: Source code, https://github.com/tom-bjorkholm/backlog-ops
10
+ Project-URL: Documentation, https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md
11
11
  Keywords: backlog,release planning,agile,scrum,scheduling,roadmap,project management,product owner,product management
12
12
  Classifier: Programming Language :: Python :: 3
13
13
  Classifier: Programming Language :: Python :: 3.12
@@ -20,12 +20,13 @@ Classifier: Intended Audience :: Developers
20
20
  Classifier: Intended Audience :: End Users/Desktop
21
21
  Classifier: Intended Audience :: Information Technology
22
22
  Classifier: Topic :: Office/Business :: Scheduling
23
+ Classifier: Typing :: Typed
23
24
  Requires-Python: >=3.12
24
25
  Description-Content-Type: text/markdown
25
26
  License-File: LICENSE.txt
26
- Requires-Dist: argcomplete>=3.6.3
27
- Requires-Dist: backlogops>=0.2
28
- Requires-Dist: versionreporter>=0.3
27
+ Requires-Dist: argcomplete>=3.7.0
28
+ Requires-Dist: backlogops>=0.3
29
+ Requires-Dist: versionreporter>=0.4
29
30
  Dynamic: author
30
31
  Dynamic: license-file
31
32
  Dynamic: requires-dist
@@ -102,6 +103,23 @@ The following functionality is available in all 3 packages:
102
103
  - A wizard to create a backlog-ops configuration file with the workforce, named
103
104
  input and output presets, level names, and status name mapping.
104
105
 
106
+ - Read a backlog and releases from Jira into a backlog and release table.
107
+
108
+ - Write a backlog to Jira, creating a new Jira issue for each backlog item.
109
+
110
+ - Update a backlog that is already in Jira, changing only the chosen columns.
111
+
112
+ - Add the releases to Jira as Jira versions.
113
+
114
+ - Update the releases in Jira, setting their dates to the planned release dates.
115
+
116
+ - Order the releases in Jira by date, by a name list, or by the input order.
117
+
118
+ - Rename releases in Jira, changing the Jira version names.
119
+
120
+ - Move backlog items to a chosen anchor in the Jira rank order, following a key
121
+ list.
122
+
105
123
  ## The operating model
106
124
 
107
125
  The operating model that most of the functionality is designed for is that the
@@ -137,8 +155,9 @@ the library:
137
155
  before the parent item starts, and the parent item cannot finish before all
138
156
  its children have finished.
139
157
 
140
- - `release` The release of the backlog item. Optional. Follows the same
141
- character rules as the key. Must not be empty string.
158
+ - `release` The release of the backlog item. Optional. Must not be empty string,
159
+ must not start or end with whitespace, and must not contain tabs, newlines or
160
+ control characters.
142
161
 
143
162
  - `team` The team responsible for the backlog item. Optional. Must not be empty
144
163
  string. Must be a valid team name. If None the item can be done by any team.
@@ -178,21 +197,27 @@ To install backlogops-cli on Microsoft Windows, run the following command:
178
197
  pip install --upgrade backlogops-cli
179
198
  ````
180
199
 
200
+ ## Using backlogops documentation
201
+
202
+ For a better understanding of how to use the library, CLI or GUI, see the user
203
+ documentation:
204
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
205
+
181
206
  ## API documentation
182
207
 
183
208
  For more detailed code documentation, see the API documentation:
184
209
 
185
- - [Library public API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_api.md)
210
+ - [Library public API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_api.md)
186
211
 
187
- - [Library protected API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_api.md)
212
+ - [Library protected API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_api.md)
188
213
 
189
- - [Library public CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_cli.md)
214
+ - [Public CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_cli.md)
190
215
 
191
- - [Library protected CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_cli.md)
216
+ - [Protected CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_cli.md)
192
217
 
193
- - [Library public GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_gui.md)
218
+ - [Public GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_gui.md)
194
219
 
195
- - [Library protected GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_gui.md)
220
+ - [Protected GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_gui.md)
196
221
 
197
222
  ## Command line backlog operations
198
223
 
@@ -206,6 +231,12 @@ backlogops_cli serves 2 purposes:
206
231
 
207
232
  ````text
208
233
 
234
+ python3 -m backlogops_cli.add_releases_to_jira
235
+ Add releases to Jira, creating a new version per release
236
+
237
+ python3 -m backlogops_cli.add_to_jira
238
+ Add a backlog to Jira, creating a new issue per item
239
+
209
240
  python3 -m backlogops_cli.adjust_release_content
210
241
  Adjust release content to fit the planned release dates
211
242
 
@@ -224,6 +255,9 @@ backlogops_cli serves 2 purposes:
224
255
  python3 -m backlogops_cli.extract_keys
225
256
  Extract backlog keys at the given levels to a key list
226
257
 
258
+ python3 -m backlogops_cli.jira_fields
259
+ Print Jira custom fields and an issue's editable fields
260
+
227
261
  python3 -m backlogops_cli.list
228
262
  List all commands available in backlogops_cli
229
263
 
@@ -242,12 +276,30 @@ backlogops_cli serves 2 purposes:
242
276
  python3 -m backlogops_cli.order_releases
243
277
  Order the releases by their planned or estimated date
244
278
 
279
+ python3 -m backlogops_cli.order_releases_in_jira
280
+ Order releases in Jira by date, a name list or the input order
281
+
245
282
  python3 -m backlogops_cli.plan_release_dates
246
283
  Set planned release dates from the estimated release dates
247
284
 
248
285
  python3 -m backlogops_cli.preset_wizard
249
286
  Create an input or output preset config file via a wizard
250
287
 
288
+ python3 -m backlogops_cli.rank_in_jira
289
+ Move key-list items to a chosen anchor in the Jira rank order
290
+
291
+ python3 -m backlogops_cli.read_jira
292
+ Read a backlog and releases from Jira and store to a file
293
+
294
+ python3 -m backlogops_cli.rename_releases_in_jira
295
+ Rename releases in Jira, changing Jira version names
296
+
297
+ python3 -m backlogops_cli.update_backlog_in_jira
298
+ Update a backlog in Jira, changing only the chosen columns
299
+
300
+ python3 -m backlogops_cli.update_releases_in_jira
301
+ Update releases in Jira, setting dates to the planned dates
302
+
251
303
  python3 -m backlogops_cli.version
252
304
  Print version information for the backlogops_cli package
253
305
 
@@ -255,9 +307,9 @@ backlogops_cli serves 2 purposes:
255
307
 
256
308
  ## Test summary
257
309
 
258
- - Test result: 1545 passed in 32s
310
+ - Test result: 2284 passed, 7 deselected in 44s
259
311
  - No flake8 warnings.
260
312
  - No mypy errors found.
261
313
  - No python layout warnings.
262
- - Built version(s): 0.2
314
+ - Built version(s): 0.3
263
315
  - Build and test using Python 3.14.6
@@ -1,36 +1,3 @@
1
- Metadata-Version: 2.4
2
- Name: backlogops-cli
3
- Version: 0.2
4
- Summary: Command line interface for backlog operations.
5
- Author: Tom Björkholm
6
- Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
7
- License-Expression: MIT
8
- Project-URL: Homepage, https://bitbucket.org/tom-bjorkholm/backlog-ops
9
- Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/backlog-ops
10
- Project-URL: Documentation, https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/
11
- Keywords: backlog,release planning,agile,scrum,scheduling,roadmap,project management,product owner,product management
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.12
14
- Classifier: Programming Language :: Python :: 3.13
15
- Classifier: Programming Language :: Python :: 3.14
16
- Classifier: Operating System :: OS Independent
17
- Classifier: Development Status :: 3 - Alpha
18
- Classifier: Environment :: Console
19
- Classifier: Intended Audience :: Developers
20
- Classifier: Intended Audience :: End Users/Desktop
21
- Classifier: Intended Audience :: Information Technology
22
- Classifier: Topic :: Office/Business :: Scheduling
23
- Requires-Python: >=3.12
24
- Description-Content-Type: text/markdown
25
- License-File: LICENSE.txt
26
- Requires-Dist: argcomplete>=3.6.3
27
- Requires-Dist: backlogops>=0.2
28
- Requires-Dist: versionreporter>=0.3
29
- Dynamic: author
30
- Dynamic: license-file
31
- Dynamic: requires-dist
32
- Dynamic: requires-python
33
-
34
1
  # backlogops-cli
35
2
 
36
3
  There are 3 related packages for backlog operations:
@@ -102,6 +69,23 @@ The following functionality is available in all 3 packages:
102
69
  - A wizard to create a backlog-ops configuration file with the workforce, named
103
70
  input and output presets, level names, and status name mapping.
104
71
 
72
+ - Read a backlog and releases from Jira into a backlog and release table.
73
+
74
+ - Write a backlog to Jira, creating a new Jira issue for each backlog item.
75
+
76
+ - Update a backlog that is already in Jira, changing only the chosen columns.
77
+
78
+ - Add the releases to Jira as Jira versions.
79
+
80
+ - Update the releases in Jira, setting their dates to the planned release dates.
81
+
82
+ - Order the releases in Jira by date, by a name list, or by the input order.
83
+
84
+ - Rename releases in Jira, changing the Jira version names.
85
+
86
+ - Move backlog items to a chosen anchor in the Jira rank order, following a key
87
+ list.
88
+
105
89
  ## The operating model
106
90
 
107
91
  The operating model that most of the functionality is designed for is that the
@@ -137,8 +121,9 @@ the library:
137
121
  before the parent item starts, and the parent item cannot finish before all
138
122
  its children have finished.
139
123
 
140
- - `release` The release of the backlog item. Optional. Follows the same
141
- character rules as the key. Must not be empty string.
124
+ - `release` The release of the backlog item. Optional. Must not be empty string,
125
+ must not start or end with whitespace, and must not contain tabs, newlines or
126
+ control characters.
142
127
 
143
128
  - `team` The team responsible for the backlog item. Optional. Must not be empty
144
129
  string. Must be a valid team name. If None the item can be done by any team.
@@ -178,21 +163,27 @@ To install backlogops-cli on Microsoft Windows, run the following command:
178
163
  pip install --upgrade backlogops-cli
179
164
  ````
180
165
 
166
+ ## Using backlogops documentation
167
+
168
+ For a better understanding of how to use the library, CLI or GUI, see the user
169
+ documentation:
170
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
171
+
181
172
  ## API documentation
182
173
 
183
174
  For more detailed code documentation, see the API documentation:
184
175
 
185
- - [Library public API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_api.md)
176
+ - [Library public API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_api.md)
186
177
 
187
- - [Library protected API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_api.md)
178
+ - [Library protected API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_api.md)
188
179
 
189
- - [Library public CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_cli.md)
180
+ - [Public CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_cli.md)
190
181
 
191
- - [Library protected CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_cli.md)
182
+ - [Protected CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_cli.md)
192
183
 
193
- - [Library public GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_gui.md)
184
+ - [Public GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_gui.md)
194
185
 
195
- - [Library protected GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_gui.md)
186
+ - [Protected GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_gui.md)
196
187
 
197
188
  ## Command line backlog operations
198
189
 
@@ -206,6 +197,12 @@ backlogops_cli serves 2 purposes:
206
197
 
207
198
  ````text
208
199
 
200
+ python3 -m backlogops_cli.add_releases_to_jira
201
+ Add releases to Jira, creating a new version per release
202
+
203
+ python3 -m backlogops_cli.add_to_jira
204
+ Add a backlog to Jira, creating a new issue per item
205
+
209
206
  python3 -m backlogops_cli.adjust_release_content
210
207
  Adjust release content to fit the planned release dates
211
208
 
@@ -224,6 +221,9 @@ backlogops_cli serves 2 purposes:
224
221
  python3 -m backlogops_cli.extract_keys
225
222
  Extract backlog keys at the given levels to a key list
226
223
 
224
+ python3 -m backlogops_cli.jira_fields
225
+ Print Jira custom fields and an issue's editable fields
226
+
227
227
  python3 -m backlogops_cli.list
228
228
  List all commands available in backlogops_cli
229
229
 
@@ -242,12 +242,30 @@ backlogops_cli serves 2 purposes:
242
242
  python3 -m backlogops_cli.order_releases
243
243
  Order the releases by their planned or estimated date
244
244
 
245
+ python3 -m backlogops_cli.order_releases_in_jira
246
+ Order releases in Jira by date, a name list or the input order
247
+
245
248
  python3 -m backlogops_cli.plan_release_dates
246
249
  Set planned release dates from the estimated release dates
247
250
 
248
251
  python3 -m backlogops_cli.preset_wizard
249
252
  Create an input or output preset config file via a wizard
250
253
 
254
+ python3 -m backlogops_cli.rank_in_jira
255
+ Move key-list items to a chosen anchor in the Jira rank order
256
+
257
+ python3 -m backlogops_cli.read_jira
258
+ Read a backlog and releases from Jira and store to a file
259
+
260
+ python3 -m backlogops_cli.rename_releases_in_jira
261
+ Rename releases in Jira, changing Jira version names
262
+
263
+ python3 -m backlogops_cli.update_backlog_in_jira
264
+ Update a backlog in Jira, changing only the chosen columns
265
+
266
+ python3 -m backlogops_cli.update_releases_in_jira
267
+ Update releases in Jira, setting dates to the planned dates
268
+
251
269
  python3 -m backlogops_cli.version
252
270
  Print version information for the backlogops_cli package
253
271
 
@@ -255,9 +273,9 @@ backlogops_cli serves 2 purposes:
255
273
 
256
274
  ## Test summary
257
275
 
258
- - Test result: 1545 passed in 32s
276
+ - Test result: 2284 passed, 7 deselected in 44s
259
277
  - No flake8 warnings.
260
278
  - No mypy errors found.
261
279
  - No python layout warnings.
262
- - Built version(s): 0.2
280
+ - Built version(s): 0.3
263
281
  - Build and test using Python 3.14.6
@@ -1,3 +1,37 @@
1
+ Metadata-Version: 2.4
2
+ Name: backlogops-cli
3
+ Version: 0.3
4
+ Summary: Command line interface for backlog operations.
5
+ Author: Tom Björkholm
6
+ Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
7
+ License-Expression: MIT
8
+ Project-URL: Homepage, https://github.com/tom-bjorkholm/backlog-ops
9
+ Project-URL: Source code, https://github.com/tom-bjorkholm/backlog-ops
10
+ Project-URL: Documentation, https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md
11
+ Keywords: backlog,release planning,agile,scrum,scheduling,roadmap,project management,product owner,product management
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Classifier: Programming Language :: Python :: 3.14
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Development Status :: 3 - Alpha
18
+ Classifier: Environment :: Console
19
+ Classifier: Intended Audience :: Developers
20
+ Classifier: Intended Audience :: End Users/Desktop
21
+ Classifier: Intended Audience :: Information Technology
22
+ Classifier: Topic :: Office/Business :: Scheduling
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.12
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE.txt
27
+ Requires-Dist: argcomplete>=3.7.0
28
+ Requires-Dist: backlogops>=0.3
29
+ Requires-Dist: versionreporter>=0.4
30
+ Dynamic: author
31
+ Dynamic: license-file
32
+ Dynamic: requires-dist
33
+ Dynamic: requires-python
34
+
1
35
  # backlogops-cli
2
36
 
3
37
  There are 3 related packages for backlog operations:
@@ -69,6 +103,23 @@ The following functionality is available in all 3 packages:
69
103
  - A wizard to create a backlog-ops configuration file with the workforce, named
70
104
  input and output presets, level names, and status name mapping.
71
105
 
106
+ - Read a backlog and releases from Jira into a backlog and release table.
107
+
108
+ - Write a backlog to Jira, creating a new Jira issue for each backlog item.
109
+
110
+ - Update a backlog that is already in Jira, changing only the chosen columns.
111
+
112
+ - Add the releases to Jira as Jira versions.
113
+
114
+ - Update the releases in Jira, setting their dates to the planned release dates.
115
+
116
+ - Order the releases in Jira by date, by a name list, or by the input order.
117
+
118
+ - Rename releases in Jira, changing the Jira version names.
119
+
120
+ - Move backlog items to a chosen anchor in the Jira rank order, following a key
121
+ list.
122
+
72
123
  ## The operating model
73
124
 
74
125
  The operating model that most of the functionality is designed for is that the
@@ -104,8 +155,9 @@ the library:
104
155
  before the parent item starts, and the parent item cannot finish before all
105
156
  its children have finished.
106
157
 
107
- - `release` The release of the backlog item. Optional. Follows the same
108
- character rules as the key. Must not be empty string.
158
+ - `release` The release of the backlog item. Optional. Must not be empty string,
159
+ must not start or end with whitespace, and must not contain tabs, newlines or
160
+ control characters.
109
161
 
110
162
  - `team` The team responsible for the backlog item. Optional. Must not be empty
111
163
  string. Must be a valid team name. If None the item can be done by any team.
@@ -145,21 +197,27 @@ To install backlogops-cli on Microsoft Windows, run the following command:
145
197
  pip install --upgrade backlogops-cli
146
198
  ````
147
199
 
200
+ ## Using backlogops documentation
201
+
202
+ For a better understanding of how to use the library, CLI or GUI, see the user
203
+ documentation:
204
+ [Using backlogops](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc//using_backlogops/README.md)
205
+
148
206
  ## API documentation
149
207
 
150
208
  For more detailed code documentation, see the API documentation:
151
209
 
152
- - [Library public API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_api.md)
210
+ - [Library public API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_api.md)
153
211
 
154
- - [Library protected API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_api.md)
212
+ - [Library protected API](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_api.md)
155
213
 
156
- - [Library public CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_cli.md)
214
+ - [Public CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_cli.md)
157
215
 
158
- - [Library protected CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_cli.md)
216
+ - [Protected CLI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_cli.md)
159
217
 
160
- - [Library public GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_gui.md)
218
+ - [Public GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_gui.md)
161
219
 
162
- - [Library protected GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_gui.md)
220
+ - [Protected GUI code documentation](https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/backlogops_protected_gui.md)
163
221
 
164
222
  ## Command line backlog operations
165
223
 
@@ -173,6 +231,12 @@ backlogops_cli serves 2 purposes:
173
231
 
174
232
  ````text
175
233
 
234
+ python3 -m backlogops_cli.add_releases_to_jira
235
+ Add releases to Jira, creating a new version per release
236
+
237
+ python3 -m backlogops_cli.add_to_jira
238
+ Add a backlog to Jira, creating a new issue per item
239
+
176
240
  python3 -m backlogops_cli.adjust_release_content
177
241
  Adjust release content to fit the planned release dates
178
242
 
@@ -191,6 +255,9 @@ backlogops_cli serves 2 purposes:
191
255
  python3 -m backlogops_cli.extract_keys
192
256
  Extract backlog keys at the given levels to a key list
193
257
 
258
+ python3 -m backlogops_cli.jira_fields
259
+ Print Jira custom fields and an issue's editable fields
260
+
194
261
  python3 -m backlogops_cli.list
195
262
  List all commands available in backlogops_cli
196
263
 
@@ -209,12 +276,30 @@ backlogops_cli serves 2 purposes:
209
276
  python3 -m backlogops_cli.order_releases
210
277
  Order the releases by their planned or estimated date
211
278
 
279
+ python3 -m backlogops_cli.order_releases_in_jira
280
+ Order releases in Jira by date, a name list or the input order
281
+
212
282
  python3 -m backlogops_cli.plan_release_dates
213
283
  Set planned release dates from the estimated release dates
214
284
 
215
285
  python3 -m backlogops_cli.preset_wizard
216
286
  Create an input or output preset config file via a wizard
217
287
 
288
+ python3 -m backlogops_cli.rank_in_jira
289
+ Move key-list items to a chosen anchor in the Jira rank order
290
+
291
+ python3 -m backlogops_cli.read_jira
292
+ Read a backlog and releases from Jira and store to a file
293
+
294
+ python3 -m backlogops_cli.rename_releases_in_jira
295
+ Rename releases in Jira, changing Jira version names
296
+
297
+ python3 -m backlogops_cli.update_backlog_in_jira
298
+ Update a backlog in Jira, changing only the chosen columns
299
+
300
+ python3 -m backlogops_cli.update_releases_in_jira
301
+ Update releases in Jira, setting dates to the planned dates
302
+
218
303
  python3 -m backlogops_cli.version
219
304
  Print version information for the backlogops_cli package
220
305
 
@@ -222,9 +307,9 @@ backlogops_cli serves 2 purposes:
222
307
 
223
308
  ## Test summary
224
309
 
225
- - Test result: 1545 passed in 32s
310
+ - Test result: 2284 passed, 7 deselected in 44s
226
311
  - No flake8 warnings.
227
312
  - No mypy errors found.
228
313
  - No python layout warnings.
229
- - Built version(s): 0.2
314
+ - Built version(s): 0.3
230
315
  - Build and test using Python 3.14.6
@@ -12,6 +12,8 @@ src/backlogops_cli/__main__.py
12
12
  src/backlogops_cli/_command_io.py
13
13
  src/backlogops_cli/_migrate_warn.py
14
14
  src/backlogops_cli/_wizard_io.py
15
+ src/backlogops_cli/add_releases_to_jira.py
16
+ src/backlogops_cli/add_to_jira.py
15
17
  src/backlogops_cli/adjust_release_content.py
16
18
  src/backlogops_cli/bloc_version_reporter.py
17
19
  src/backlogops_cli/config_wizard.py
@@ -19,13 +21,20 @@ src/backlogops_cli/convert.py
19
21
  src/backlogops_cli/demo_backlog.py
20
22
  src/backlogops_cli/estimate_ready_date.py
21
23
  src/backlogops_cli/extract_keys.py
24
+ src/backlogops_cli/jira_fields.py
22
25
  src/backlogops_cli/list.py
23
26
  src/backlogops_cli/migrate_cfg.py
24
27
  src/backlogops_cli/order_by_deps.py
25
28
  src/backlogops_cli/order_by_keys.py
26
29
  src/backlogops_cli/order_by_release.py
27
30
  src/backlogops_cli/order_releases.py
31
+ src/backlogops_cli/order_releases_in_jira.py
28
32
  src/backlogops_cli/plan_release_dates.py
29
33
  src/backlogops_cli/preset_wizard.py
30
34
  src/backlogops_cli/py.typed
35
+ src/backlogops_cli/rank_in_jira.py
36
+ src/backlogops_cli/read_jira.py
37
+ src/backlogops_cli/rename_releases_in_jira.py
38
+ src/backlogops_cli/update_backlog_in_jira.py
39
+ src/backlogops_cli/update_releases_in_jira.py
31
40
  src/backlogops_cli/version.py
@@ -0,0 +1,3 @@
1
+ argcomplete>=3.7.0
2
+ backlogops>=0.3
3
+ versionreporter>=0.4
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "backlogops-cli"
7
- version = "0.2"
7
+ version = "0.3"
8
8
  authors = [
9
9
  { name="Tom Björkholm", email="klausuler_linnet0q@icloud.com" },
10
10
  ]
@@ -27,11 +27,12 @@ classifiers = [
27
27
  "Intended Audience :: Developers",
28
28
  "Intended Audience :: End Users/Desktop",
29
29
  "Intended Audience :: Information Technology",
30
- "Topic :: Office/Business :: Scheduling"
30
+ "Topic :: Office/Business :: Scheduling",
31
+ "Typing :: Typed"
31
32
  ]
32
33
  dynamic = ["dependencies"]
33
34
 
34
35
  [project.urls]
35
- "Homepage" = "https://bitbucket.org/tom-bjorkholm/backlog-ops"
36
- "Source code" = "https://bitbucket.org/tom-bjorkholm/backlog-ops"
37
- "Documentation" = "https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/"
36
+ "Homepage" = "https://github.com/tom-bjorkholm/backlog-ops"
37
+ "Source code" = "https://github.com/tom-bjorkholm/backlog-ops"
38
+ "Documentation" = "https://github.com/tom-bjorkholm/backlog-ops/blob/master/doc/using_backlogops/README.md"
@@ -5,7 +5,7 @@ from setuptools import setup
5
5
 
6
6
  setup(
7
7
  name='backlogops-cli',
8
- version='0.2',
8
+ version='0.3',
9
9
  description='Command line interface for backlog operations.',
10
10
  author='Tom Björkholm',
11
11
  author_email='klausuler_linnet0q@icloud.com',
@@ -14,8 +14,8 @@ setup(
14
14
  package_dir={'backlogops_cli': 'src/backlogops_cli'},
15
15
  package_data={'backlogops_cli': ['src/py.typed']},
16
16
  install_requires=[
17
- 'argcomplete >= 3.6.3',
18
- 'backlogops >= 0.2',
19
- 'versionreporter >= 0.3'
17
+ 'argcomplete >= 3.7.0',
18
+ 'backlogops >= 0.3',
19
+ 'versionreporter >= 0.4'
20
20
  ]
21
21
  )