backlogops 0.1__py3-none-any.whl

backlogops-0.1.dist-info/METADATA

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: backlogops
+Version: 0.1
+Summary: Library with backlog operations.
+Author: Tom Björkholm
+Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
+License-Expression: MIT
+Project-URL: Homepage, https://bitbucket.org/tom-bjorkholm/backlog-ops
+Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/backlog-ops
+Project-URL: Documentation, https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/
+Keywords: backlog,release planning,agile,scrum,scheduling,roadmap,project management,product owner,product management
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Office/Business :: Scheduling
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: config-as-json>=1.2
+Requires-Dist: tableio>=1.0
+Requires-Dist: tableio-cfg-json>=0.4
+Requires-Dist: versionreporter>=0.2
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+
+# backlogops
+
+There are 3 related packages for backlog operations:
+
+- backlogops: a collection of library functions to manipulate backlogs
+
+- backlogops-cli: command line interface to use the functions in the library.
+  This is just a thin wrapper around the library functions. It serves a dual
+  purpose as both an example of how to use the library and as a tool for the
+  user to use the library.
+
+- backlogops-gui: graphical user interface to use the functions in the library.
+  It is based on TkInter. The ambition is to keep it as a thin wrapper around
+  the library.
+
+## Available functionality
+
+The following functionality is available in all 3 packages:
+
+- Reading backlog and releases from file types that TableIO supports reading
+  from (Currently CSV, Excel, and ODS).
+
+- Writing backlog and releases to file types that TableIO supports writing to
+  (Currently CSV, Excel, ODS and 9 other file formats).
+
+- File format is detected from the file extension, but may be overridden.
+
+- Adjust release content to fit the planned release dates.
+
+- Create a demonstration backlog and releases (for exploring the features).
+
+- Estimate ready date for the backlog items based on available teams, team
+  velocity, vacation dates, periods with half time work, etc.
+
+- Extract backlog keys at given backlog item levels.
+
+- Reorder the backlog so that the dependencies are satisfied.
+
+- Reorder the backlog so that items identified by keys in a list come first. If
+  the key is at a higher level it will bring all items it is a parent of in
+  front of it (recursively).
+
+- Set planned release dates from the estimated release dates.
+
+- Calculate the release dates from the backlog items estimated ready dates, with
+  a configurable buffer time.
+
+- Validate the backlog and releases for consistency.
+
+- A wizard to create an available teams configuration.
+
+## The operating model
+
+The operating model that most of the functionality is designed for is that the
+teams work off a single backlog in the order of the backlog. The backlog items
+are ordered by priority and dependencies to allow the teams to work in the
+backlog order. Each backlog item and each release may have a planned ready date,
+that records what has been communicated to the customer. Each backlog item and
+each release may have an estimated ready date, that is calculated from the
+current backlog state, the team velocity, and what we know about the
+availability of the team members.
+
+## The backlog item fields
+
+Each backlog item has the following fields that are used by the algorithms in
+the library:
+
+- key: The key of the backlog item. Required. Must be unique. Must not be empty,
+  must not contain whitespace and must not contain any of the characters , . ; :
+  ( ) \[ \] \{ \}.
+
+- level: The level of the backlog item. Required. Must be an integer.
+
+- title: The title of the backlog item. Required.
+
+- story_points: The story points of the backlog item. Required.
+
+- status: The status of the backlog item. Required.
+
+- parent_key: The key of the parent backlog item. Optional. Must exist as a key
+  in the backlog. Parent keys are used to build the hierarchy of the backlog.
+  The parent key must be at a higher level than the current item. Parent keys
+  introduce implicit dependencies between items: the current item cannot start
+  before the parent item starts, and the parent item cannot finish before all
+  its children have finished.
+
+- release: The release of the backlog item. Optional. Follows the same character
+  rules as the key. Must not be empty string.
+
+- team: The team responsible for the backlog item. Optional. Must not be empty
+  string. Must be a valid team name. If None the item can be done by any team.
+  If not None. the item can only be done by the specified team.
+
+- depends_on_f2s: The list of keys of the backlog items that must have been
+  finished before the current item can start. May be empty.
+
+- depends_on_f2f: The list of keys of the backlog items that must have been
+  finished before the current item can finish. May be empty.
+
+- depends_on_s2s: The list of keys of the backlog items that must have been
+  started before the current item can start. May be empty.
+
+- planned_ready_date: The planned ready date of the backlog item. The date that
+  is communicated to the customer. Optional.
+
+- estimated_ready_date: The estimated ready date of the backlog item. Optional.
+
+Additionally each backlog item can have any number of other fields.
+
+## Installing backlogops
+
+### On macOS and Linux
+
+To install backlogops on macOS and Linux, run the following command:
+
+````sh
+pip3 install --upgrade backlogops
+````
+
+### On Microsoft Windows
+
+To install backlogops on Microsoft Windows, run the following command:
+
+````sh
+pip install --upgrade backlogops
+````
+
+## API documentation
+
+For more detailed code documentation, see the API documentation:
+
+- [Library public API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_api.md)
+
+- [Library protected API](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_api.md)
+
+- [Library public CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_cli.md)
+
+- [Library protected CLI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_cli.md)
+
+- [Library public GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_gui.md)
+
+- [Library protected GUI](https://bitbucket.org/tom-bjorkholm/backlog-ops/src/master/doc/backlogops_protected_gui.md)
+
+## Library main entry points
+
+All names an application programmer is most likely to need are
+re-exported from the top-level `backlogops` package, so they can be
+imported directly, for example:
+
+````python
+from backlogops import (
+    read_backlog_releases, order_by_dependencies, estimate_ready_date,
+    get_demo_backlog)
+````
+
+### Core data model
+
+- `Backlog`, `BacklogItem`, `Status`: the backlog and its items.
+
+- `Releases`, `Release`: the planned releases.
+
+- `BacklogReleases`: a backlog together with its releases.
+
+- `AvailableTeams`, `Team`, `Person`, `Membership`: the workforce that
+  the date estimation uses.
+
+### Reading and writing
+
+- `read_backlog_releases`, `write_backlog_releases`: read and write a
+  backlog and its releases from and to a table file.
+
+- `read_available_teams`, `write_available_teams`: read and write the
+  available-teams configuration.
+
+- `read_key_list`, `write_key_list`: read and write a list of keys.
+
+- `get_demo_backlog`: create a demonstration backlog and releases.
+
+### Operations
+
+- `order_by_dependencies`: reorder the backlog so that dependencies are
+  satisfied.
+
+- `move_keys_first`: reorder so that listed keys (and their children)
+  come first.
+
+- `estimate_ready_date`, `set_plan_from_estimate`: estimate ready dates
+  and set planned dates from the estimate.
+
+- `estimate_release_dates`, `release_plan_on_estimate`,
+  `adjust_release_content`: estimate and plan release dates, and adjust
+  release content to fit the planned dates.
+
+- `check_backlog_consistency`: validate the backlog and releases for
+  consistency.
+
+For the full set of public names see the API documentation linked above.
+
+## Test summary
+
+- Test result: 1066 passed in 16s
+- No flake8 warnings.
+- No mypy errors found.
+- No python layout warnings.
+- Built version(s): 0.1
+- Build and test using Python 3.14.6

backlogops-0.1.dist-info/RECORD

@@ -0,0 +1,34 @@
+backlogops/__init__.py,sha256=2T91n4MnG6phui4pn_AyVc8zXhsuqlkQlcsmFZU0Ick,4552
+backlogops/apply_format_rules.py,sha256=_5azzJMRxk47JFaVBsa5KSI-tFJXlG0WrUiIGuTgSU0,3554
+backlogops/available_teams.py,sha256=7ROS0hSaUqL5xnm-CnF7eH2HVszC2qgUxxwyLY-ARrA,8828
+backlogops/available_teams_config.py,sha256=0n1zD7laF5G2J1Hym8gmN93hGDH5-AyRAjPBLM4R7Pk,22441
+backlogops/available_teams_wizard.py,sha256=yf2nogpDnbVbRSgmD5EClcE254G0lZ1vo9FCZ9NyMkU,18528
+backlogops/backlog.py,sha256=OP1uY0RLiPjHH8TgcgiYUOQcOy9GaD2vVpPbDSOFCXY,19128
+backlogops/backlog_helpers.py,sha256=QZoyzSpCmgX_juo-nVRYOF-R-J-uwQZr03bhEj42DCc,24247
+backlogops/backlog_releases.py,sha256=gJO8cngsoM4C_gmFzAXvCohCmi1_1zgVMcxwdGrpIUI,13382
+backlogops/backlog_releases_io.py,sha256=t6TEKZA2IM7zSOmRM_4x-4LCjm1Ivm0odR9d4YudMpw,9177
+backlogops/console_yes_no_bridge.py,sha256=Li12__Cb35lGIPCV4c7-M-ABQ6BYAktN0nlU8h2GvuE,1664
+backlogops/date_ranges.py,sha256=fwQuh7k-KTfVGKucHrXUr7cvgujgL-eAFBBXYmVrnuM,2134
+backlogops/demo_backlog.py,sha256=xcJJt2avp_2F3yzR1W7bXxAhTbAdtyPTBVfc1UmsyY0,4817
+backlogops/estimate_ready_date.py,sha256=FEY6apg04JI_gM7wbJIuM2PBSEA_gNBQCOgbCq8K6rQ,15434
+backlogops/format_rules.py,sha256=tzSMi1YPXNHquwvctLl5Qcuv2zuYOWf5SnrAmzJn8wg,2616
+backlogops/io_config.py,sha256=V4t14IleJ6eO6YcykORmKfPdsqS0ArWnhMTI5WRa91E,12089
+backlogops/key_list_io.py,sha256=TbQoDBMMqTBVjZuAvGNM_AUc19-ANV9WmOqzTkOmNsI,9517
+backlogops/levels.py,sha256=0nA1t-rdjcU4p2HxSYVWzoIJDGH40FdmS9mtPtjOhbk,6561
+backlogops/move_keys_first.py,sha256=xCMUv_Z-yvs2JmrstepMxosZxRfh_teiWhF2JL9y0VM,6861
+backlogops/no_text_io.py,sha256=0mC5ktLyvOTZL0W-w1oDkNHrcllEWde_RvjcjhR5k9Q,2594
+backlogops/order_by_dependencies.py,sha256=OgOpa0wnPguSUd8hHLm9h4orDKoXQyWhgH6KBKdh7gM,15759
+backlogops/person.py,sha256=vjL45iDKR-6vrajZSw9x1WjC_98HrF20UI94BdNnZ00,749
+backlogops/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+backlogops/release_backlog_updates.py,sha256=3IyirXo2G2Y4BJNKUN_yPmfNZVV2z8gW1rDwTJtup20,8996
+backlogops/release_change_io.py,sha256=TlYC-uDEw-Hn_AK-RxLEDQ91wMKnrW__Hu8Oj3DOFo4,5211
+backlogops/releases.py,sha256=g5I9htddip697N67Lh-nvetLSVlPXn6VPWffnRRcNw4,6382
+backlogops/table_create.py,sha256=5iEEQ5bm4EoGPrJZlEFJuWB9sVpOAYATaLp1htXsGJU,1811
+backlogops/table_rows.py,sha256=bEQNAnYLGM_mNClFslooecsa_Q29YkcEfk0UUVkV4gY,4474
+backlogops/team.py,sha256=3rk7-nPxSaiaB2EiDXv00X47h63F-g8sNPjUi0CDJvM,7966
+backlogops/work_hours.py,sha256=dpzKFLtjeTpThKk6lWeGvss5zpm6MzSFwKa45rXUH_4,5951
+backlogops-0.1.dist-info/licenses/LICENSE.txt,sha256=YbzYf1byKHV7rKnb_zN_ouS8n9ttzGcYHpfTdTf-dPk,1072
+backlogops-0.1.dist-info/METADATA,sha256=3GCzoNUUXUqlaBs_mHAioTaBWFCfShmy8sk7NQ2t4pM,8694
+backlogops-0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+backlogops-0.1.dist-info/top_level.txt,sha256=KXiJZCfBVeb2m5OQQ8lrxKFeJ-bZ9qP1WjheMtwd_6I,11
+backlogops-0.1.dist-info/RECORD,,

backlogops-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

backlogops-0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Tom Björkholm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

backlogops-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+backlogops