backlogops 0.9__tar.gz → 1.0__tar.gz

{backlogops-0.9 → backlogops-1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: backlogops
-Version: 0.9
+Version: 1.0
 Summary: Library with backlog operations.
 Author: Tom Björkholm
 Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -25,10 +25,10 @@ Requires-Dist: config-as-json>=1.5
 Requires-Dist: cryptography>=50.0.0
 Requires-Dist: jira[cli,opt]>=3.10.5
 Requires-Dist: tableio>=1.1
-Requires-Dist: tableio-cfg-json>=1.2
+Requires-Dist: tableio-cfg-json>=1.3
 Requires-Dist: wizard-ui-bridge[textual]>=1.3
-Requires-Dist: edit-cfg-json==0.0.2
 Requires-Dist: versionreporter>=0.4
+Requires-Dist: edit-cfg-json==0.0.4
 Dynamic: author
 Dynamic: license-file
 Dynamic: requires-dist
@@ -271,15 +271,12 @@ from backlogops import (
 
 ### Editing a configuration
 
-- `edit_model_for`, `default_edit_config`: build the `edit-cfg-json` model
-  of an editing session over a `BacklogOpsConfig` or a stand-alone input
-  or output preset, for the Tkinter editor of the graphical interface and
-  the Textual editor of the command line.
-
 - `CONFIG_DESCRIPTIONS`, `INPUT_DESCRIPTIONS`, `OUTPUT_DESCRIPTIONS`:
   what each configuration member is for, shown below it in the editor.
   A member has no docstring at runtime, so this is what the editor is
   told; `descriptions_for` picks the mapping of one configuration class.
+  The nested TableIO endpoint is described by `tableio-cfg-json`, which
+  is asked for that text rather than having it repeated here.
 
 - `EDIT_SETTINGS`: what the editor may do to a configuration file of this
   application, including keeping what it writes over as a `.bak` file.
@@ -328,10 +325,10 @@ For the full set of public names see the API documentation linked above.
 
 ## Test summary
 
-- Test result: 2232 passed, 1 deselected in 44s
+- Test result: 2234 passed, 1 deselected in 45s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.9
+- Built version(s): 1.0
 - Build and test using Python 3.14.7

{backlogops-0.9 → backlogops-1.0}/README_pypi.md

@@ -235,15 +235,12 @@ from backlogops import (
 
 ### Editing a configuration
 
-- `edit_model_for`, `default_edit_config`: build the `edit-cfg-json` model
-  of an editing session over a `BacklogOpsConfig` or a stand-alone input
-  or output preset, for the Tkinter editor of the graphical interface and
-  the Textual editor of the command line.
-
 - `CONFIG_DESCRIPTIONS`, `INPUT_DESCRIPTIONS`, `OUTPUT_DESCRIPTIONS`:
   what each configuration member is for, shown below it in the editor.
   A member has no docstring at runtime, so this is what the editor is
   told; `descriptions_for` picks the mapping of one configuration class.
+  The nested TableIO endpoint is described by `tableio-cfg-json`, which
+  is asked for that text rather than having it repeated here.
 
 - `EDIT_SETTINGS`: what the editor may do to a configuration file of this
   application, including keeping what it writes over as a `.bak` file.
@@ -292,10 +289,10 @@ For the full set of public names see the API documentation linked above.
 
 ## Test summary
 
-- Test result: 2232 passed, 1 deselected in 44s
+- Test result: 2234 passed, 1 deselected in 45s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.9
+- Built version(s): 1.0
 - Build and test using Python 3.14.7

{backlogops-0.9 → backlogops-1.0}/backlogops.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: backlogops
-Version: 0.9
+Version: 1.0
 Summary: Library with backlog operations.
 Author: Tom Björkholm
 Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -25,10 +25,10 @@ Requires-Dist: config-as-json>=1.5
 Requires-Dist: cryptography>=50.0.0
 Requires-Dist: jira[cli,opt]>=3.10.5
 Requires-Dist: tableio>=1.1
-Requires-Dist: tableio-cfg-json>=1.2
+Requires-Dist: tableio-cfg-json>=1.3
 Requires-Dist: wizard-ui-bridge[textual]>=1.3
-Requires-Dist: edit-cfg-json==0.0.2
 Requires-Dist: versionreporter>=0.4
+Requires-Dist: edit-cfg-json==0.0.4
 Dynamic: author
 Dynamic: license-file
 Dynamic: requires-dist
@@ -271,15 +271,12 @@ from backlogops import (
 
 ### Editing a configuration
 
-- `edit_model_for`, `default_edit_config`: build the `edit-cfg-json` model
-  of an editing session over a `BacklogOpsConfig` or a stand-alone input
-  or output preset, for the Tkinter editor of the graphical interface and
-  the Textual editor of the command line.
-
 - `CONFIG_DESCRIPTIONS`, `INPUT_DESCRIPTIONS`, `OUTPUT_DESCRIPTIONS`:
   what each configuration member is for, shown below it in the editor.
   A member has no docstring at runtime, so this is what the editor is
   told; `descriptions_for` picks the mapping of one configuration class.
+  The nested TableIO endpoint is described by `tableio-cfg-json`, which
+  is asked for that text rather than having it repeated here.
 
 - `EDIT_SETTINGS`: what the editor may do to a configuration file of this
   application, including keeping what it writes over as a `.bak` file.
@@ -328,10 +325,10 @@ For the full set of public names see the API documentation linked above.
 
 ## Test summary
 
-- Test result: 2232 passed, 1 deselected in 44s
+- Test result: 2234 passed, 1 deselected in 45s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.9
+- Built version(s): 1.0
 - Build and test using Python 3.14.7

{backlogops-0.9 → backlogops-1.0}/backlogops.egg-info/requires.txt

@@ -2,7 +2,7 @@ config-as-json>=1.5
 cryptography>=50.0.0
 jira[cli,opt]>=3.10.5
 tableio>=1.1
-tableio-cfg-json>=1.2
+tableio-cfg-json>=1.3
 wizard-ui-bridge[textual]>=1.3
-edit-cfg-json==0.0.2
 versionreporter>=0.4
+edit-cfg-json==0.0.4

{backlogops-0.9 → backlogops-1.0}/setup.py

@@ -5,7 +5,7 @@ from setuptools import setup
 
 setup(
   name='backlogops',
-  version='0.9',
+  version='1.0',
   description='Library with backlog operations.',
   author='Tom Björkholm',
   author_email='klausuler_linnet0q@icloud.com',
@@ -18,9 +18,9 @@ setup(
     'cryptography >= 50.0.0',
     'jira[cli,opt] >= 3.10.5',
     'tableio >= 1.1',
-    'tableio-cfg-json >= 1.2',
+    'tableio-cfg-json >= 1.3',
     'wizard-ui-bridge[textual] >= 1.3',
-    'edit-cfg-json == 0.0.2',
-    'versionreporter >= 0.4'
+    'versionreporter >= 0.4',
+    'edit-cfg-json == 0.0.4'
   ]
 )

{backlogops-0.9 → backlogops-1.0}/src/backlogops/__init__.py

@@ -32,8 +32,7 @@ from backlogops.backlog_releases_io import (
 from backlogops.config_descriptions import (
     CONFIG_DESCRIPTIONS, GUI_DESCRIPTIONS, INPUT_DESCRIPTIONS,
     JIRA_DESCRIPTIONS, OUTPUT_DESCRIPTIONS, WORKFORCE_DESCRIPTIONS)
-from backlogops.config_editing import (
-    EDIT_SETTINGS, default_edit_config, descriptions_for, edit_model_for)
+from backlogops.config_editing import EDIT_SETTINGS, descriptions_for
 from backlogops.config_file_io import (
     CONFIG_EXTENSION, io_preset_class, read_io_preset, safe_write_config)
 from backlogops.date_ranges import check_date_range, check_no_overlap
@@ -141,9 +140,9 @@ __all__ = [
     'apply_jira_keys', 'available_teams_wizard', 'backlog_in_release_order',
     'backlog_ops_wizard', 'build_backlog_releases', 'build_dependency_graph',
     'check_backlog_consistency', 'check_date_range',
-    'check_levels_consistency', 'check_no_overlap', 'default_edit_config',
+    'check_levels_consistency', 'check_no_overlap',
     'default_jira_filter', 'descriptions_for',
-    'display_level_order', 'display_level_rows', 'edit_model_for',
+    'display_level_order', 'display_level_rows',
     'encrypt_token_file',
     'encrypt_token_to_file', 'estimate_ready_date', 'estimate_release_dates',
     'event_finish', 'event_start', 'find_cycle', 'fold_level_name',

{backlogops-0.9 → backlogops-1.0}/src/backlogops/config_descriptions.py

@@ -40,11 +40,15 @@ more names than fit in one such line has the meaning of them said about the
 member instead, which is why ``token_storage`` explains its modes here and
 ``level_display`` does not.
 
-Two more things are deliberately left out. The nested TableIO endpoint is
-described by ``tableio_cfg_json``, which owns those members and documents
-them itself, so only the member holding it is described here. And a limit
-that lives inside a validator is not read by the editor and is stated in
-words where it matters.
+The nested TableIO endpoint is described by ``tableio_cfg_json``, which
+owns those members: :func:`tio_json_descriptions` is asked for their text
+under the path of the member holding the endpoint, so the TableIO
+documentation is neither repeated here nor able to drift from it. What is
+written here about that endpoint is the one line about the member itself.
+
+One more thing is deliberately left out: a limit that lives inside a
+validator is not read by the editor and is stated in words where it
+matters.
 """
 
 # Copyright (c) 2026, Tom Björkholm
@@ -52,6 +56,7 @@ words where it matters.
 
 from config_as_json import ConfigPath
 from edit_cfg_json import Descriptions
+from tableio_cfg_json import tio_json_descriptions
 
 EVERY = '['
 """The path step meaning every element of a list or every value of a dict.
@@ -169,12 +174,17 @@ WORKFORCE_DESCRIPTIONS: Descriptions = {
                _FTE_EXCEPTION)}
 """What every member of an ``AvailableTeamsConfig`` is for."""
 
-_TABLEIO_MEMBER = ('How the file itself is read or written: its format, and '
-                   'the settings of that format. These are the members of '
-                   'tableio-cfg-json, which documents them; a setting that '
-                   'is not in the file keeps its default and has no line '
-                   'here.')
-"""What the nested TableIO endpoint of one preset is for."""
+_TABLEIO: Descriptions = {
+    ('tableio',): 'How the file itself is read or written: its format, and '
+                  'the settings of that format. A setting that is not in '
+                  'the file keeps its default and has no line here.',
+    **tio_json_descriptions(('tableio',))}
+"""What the nested TableIO endpoint of one preset and its settings are for.
+
+Only the line about the member itself is written here. Everything below it
+belongs to ``tableio_cfg_json``, which is asked for it, so the formats,
+implementations and values named are the ones registered now.
+"""
 
 _MAPPED_COLUMN = ('Empty drops the column altogether. A column that is not '
                   'named here keeps its own name.')
@@ -198,7 +208,7 @@ INPUT_DESCRIPTIONS: Descriptions = {
                            'alone.',
     ('status_input_map', EVERY): 'Internal status this name is read as: one '
                                  'of TODO, IN_PROGRESS, DONE or REJECTED.',
-    ('tableio',): _TABLEIO_MEMBER}
+    **_TABLEIO}
 """What every member of an ``InputFormatConfig`` is for."""
 
 
@@ -231,7 +241,7 @@ def _display_members(action: str) -> Descriptions:
 
 
 OUTPUT_DESCRIPTIONS: Descriptions = {**_display_members('written'),
-                                     ('tableio',): _TABLEIO_MEMBER}
+                                     **_TABLEIO}
 """What every member of an ``OutputFormatConfig`` is for."""
 
 GUI_DESCRIPTIONS: Descriptions = _display_members('shown')

backlogops-1.0/src/backlogops/config_editing.py

@@ -0,0 +1,90 @@
+#! /usr/local/bin/python3
+"""What a configuration editor of a UI is told about this application.
+
+The wizard asks one question after another, which is what building a
+configuration from nothing wants. Editing an existing one wants the other
+shape: the whole configuration on the screen at once, folded where it is
+deep, so a single value can be changed without walking past everything
+else. ``edit_cfg_json`` is that editor, and this module is the two answers
+it asks the application for, so that the command line and the graphical
+interface show one configuration the same way.
+
+The first answer is :func:`descriptions_for`, which is what each editable
+class says about its own members. Which class is edited is the class of the
+configuration object the editor is given, so the caller decides whether a
+complete backlog-ops configuration or a stand-alone preset is being edited,
+and the descriptions of that class follow from it. A caller that has a
+class rather than an object, such as a command line naming the kind of file
+it edits, gets the object from ``edit_cfg_json.default_config``.
+
+The second answer is :data:`EDIT_SETTINGS`, which is what the editor may do
+to a file. Saving is the editor's own: it validates the whole configuration
+through the configuration class and only then writes, keeping what it wrote
+over as a ``.bak`` file, because an editor overwrites the file it read.
+
+Nothing here opens an editor. A user interface that already runs its own
+toolkit mounts the editor itself — ``edit_cfg_json_tk.TkEditorPanel`` in a
+window of the application, ``edit_cfg_json_textual.edit`` in a terminal of
+its own — and hands those two answers to it.
+
+Three things the editor cannot do are worth knowing before it is offered
+instead of the wizard, and all three are of ``edit_cfg_json`` itself rather
+than of this configuration:
+
+* A dict whose keys the application validates for itself cannot gain or
+  lose a key. That is the status map, the column-name maps of a preset and
+  of the display, and the Jira column and issue-type maps: their values are
+  editable, and a new entry is the wizard's to create.
+* A member left out of the file has no row, so the levels can be edited
+  only in a configuration that already states them.
+* A person is keyed by their own name in lower case, so renaming one means
+  adding an entry under the new key and removing the old one; editing the
+  name alone leaves a configuration the class refuses.
+"""
+
+# Copyright (c) 2026, Tom Björkholm
+# MIT License
+
+from typing import Optional
+from config_as_json import Config
+from edit_cfg_json import Descriptions, Settings
+from backlogops.backlog_ops_config import BacklogOpsConfig
+from backlogops.config_descriptions import CONFIG_DESCRIPTIONS, \
+    INPUT_DESCRIPTIONS, OUTPUT_DESCRIPTIONS
+from backlogops.config_file_io import CONFIG_EXTENSION
+from backlogops.io_config import InputFormatConfig, OutputFormatConfig
+
+EDIT_SETTINGS = Settings(file_extension=CONFIG_EXTENSION,
+                         extension_enforced=False, backup_suffix='.bak',
+                         backup_count=1, confirm_overwrite=True)
+"""What the editor may do to a configuration file of this application.
+
+The extension is added to a destination that has none, and a name with
+another extension is accepted, which is how the wizard commands complete a
+file name too. Overwriting a file this session has not written is confirmed
+first and the previous content is then kept as that name plus ``.bak``,
+because the editor writes over the file it read and that file may hold a
+configuration somebody else wrote.
+
+The default key combinations apply: none of them is taken by the
+application around the editor.
+"""
+
+CLASS_DESCRIPTIONS: dict[type[Config], Descriptions] = {
+    BacklogOpsConfig: CONFIG_DESCRIPTIONS,
+    InputFormatConfig: INPUT_DESCRIPTIONS,
+    OutputFormatConfig: OUTPUT_DESCRIPTIONS}
+"""What each editable configuration class says about its own members."""
+
+
+def descriptions_for(config: Config) -> Optional[Descriptions]:
+    """Return what the class of one configuration says about its members.
+
+    Args:
+        config: The configuration object that is to be edited.
+
+    Returns:
+        The descriptions of that class, or None for a class this library
+        says nothing about, which the editor shows without descriptions.
+    """
+    return CLASS_DESCRIPTIONS.get(type(config))

backlogops-0.9/src/backlogops/config_editing.py

@@ -1,149 +0,0 @@
-#! /usr/local/bin/python3
-"""Build the edit model that a configuration editor of a UI shows.
-
-The wizard asks one question after another, which is what building a
-configuration from nothing wants. Editing an existing one wants the other
-shape: the whole configuration on the screen at once, folded where it is
-deep, so a single value can be changed without walking past everything
-else. ``edit_cfg_json`` is that editor, and this module is everything of it
-that is not a widget, so that the command line and the graphical interface
-show one configuration the same way.
-
-:func:`edit_model_for` reads the input file and returns the model to show.
-Which class is edited is the class of the configuration object it is given,
-so the caller decides whether a complete backlog-ops configuration or a
-stand-alone preset is being edited, and the descriptions of that class
-follow from it. A caller that has a class rather than an object, such as a
-command line naming the kind of file it edits, gets the object from
-:func:`default_edit_config`.
-
-What the editor may do to a file is :data:`EDIT_SETTINGS`. Saving is the
-editor's own: it validates the whole configuration through the
-configuration class and only then writes, keeping what it wrote over as a
-``.bak`` file, because an editor overwrites the file it read.
-
-Three things the editor cannot do are worth knowing before it is offered
-instead of the wizard, and all three are of ``edit_cfg_json`` itself rather
-than of this configuration:
-
-* A dict whose keys the application validates for itself cannot gain or
-  lose a key. That is the status map, the column-name maps of a preset and
-  of the display, and the Jira column and issue-type maps: their values are
-  editable, and a new entry is the wizard's to create.
-* A member left out of the file has no row, so the levels can be edited
-  only in a configuration that already states them.
-* A person is keyed by their own name in lower case, so renaming one means
-  adding an entry under the new key and removing the old one; editing the
-  name alone leaves a configuration the class refuses.
-"""
-
-# Copyright (c) 2026, Tom Björkholm
-# MIT License
-
-import sys
-from typing import Optional, TextIO
-from config_as_json import Config, PathOrStr
-from edit_cfg_json import ConfigLoadError, Descriptions, EditModel, Settings, \
-    default_config, load_config
-from backlogops.backlog_ops_config import BacklogOpsConfig
-from backlogops.config_descriptions import CONFIG_DESCRIPTIONS, \
-    INPUT_DESCRIPTIONS, OUTPUT_DESCRIPTIONS
-from backlogops.config_file_io import CONFIG_EXTENSION
-from backlogops.io_config import InputFormatConfig, OutputFormatConfig
-
-EDIT_SETTINGS = Settings(file_extension=CONFIG_EXTENSION,
-                         extension_enforced=False, backup_suffix='.bak',
-                         backup_count=1, confirm_overwrite=True)
-"""What the editor may do to a configuration file of this application.
-
-The extension is added to a destination that has none, and a name with
-another extension is accepted, which is how the wizard commands complete a
-file name too. Overwriting a file this session has not written is confirmed
-first and the previous content is then kept as that name plus ``.bak``,
-because the editor writes over the file it read and that file may hold a
-configuration somebody else wrote.
-
-The default key combinations apply: none of them is taken by the
-application around the editor.
-"""
-
-CLASS_DESCRIPTIONS: dict[type[Config], Descriptions] = {
-    BacklogOpsConfig: CONFIG_DESCRIPTIONS,
-    InputFormatConfig: INPUT_DESCRIPTIONS,
-    OutputFormatConfig: OUTPUT_DESCRIPTIONS}
-"""What each editable configuration class says about its own members."""
-
-
-def descriptions_for(config: Config) -> Optional[Descriptions]:
-    """Return what the class of one configuration says about its members.
-
-    Args:
-        config: The configuration object that is to be edited.
-
-    Returns:
-        The descriptions of that class, or None for a class this library
-        says nothing about, which the editor shows without descriptions.
-    """
-    return CLASS_DESCRIPTIONS.get(type(config))
-
-
-def default_edit_config(config_type: type[Config]) -> Config:
-    """Return a configuration holding the declared defaults of one class.
-
-    It is the door for a caller that has a class rather than an object,
-    which is what a command line naming the kind of file it edits has.
-
-    Args:
-        config_type: The configuration class to be edited.
-
-    Returns:
-        A configuration object holding only what that class declares.
-
-    Raises:
-        ValueError: The editor cannot construct that class on its own.
-    """
-    try:
-        return default_config(config_type)
-    except ConfigLoadError as error:
-        raise ValueError(str(error)) from error
-
-
-def edit_model_for(config: Config, *, in_file: Optional[PathOrStr] = None,
-                   out_file: Optional[PathOrStr] = None,
-                   stderr_file: TextIO = sys.stderr) -> EditModel:
-    """Read the configuration to edit and return the model of a session.
-
-    The class of ``config`` decides which class is edited and supplies the
-    values a member the input file leaves out falls back to. The object
-    itself is never modified: what a save wrote is
-    ``EditModel.saved_config``.
-
-    Args:
-        config: Configuration object of the class to edit, holding the
-            values to start from when there is no input file.
-        in_file: Configuration file to read, or None to edit the values
-            that ``config`` holds.
-        out_file: Configuration file a save writes, or None to write the
-            input file. With neither, the editor asks the user for one
-            before it can save. A destination named here is one this
-            session chose, so it is given the configuration extension when
-            it has none; the input file is inherited and taken as it is.
-        stderr_file: Stream used for user-facing diagnostics.
-
-    Returns:
-        The model of one editing session, for a UI backend to show.
-
-    Raises:
-        ValueError: The input file cannot be opened for editing. The
-            message holds what the configuration class said about it.
-    """
-    try:
-        loaded = load_config(config, in_file=in_file, settings=EDIT_SETTINGS)
-    except ConfigLoadError as error:
-        raise ValueError(str(error)) from error
-    model = EditModel(loaded.config, loaded.report,
-                      descriptions=descriptions_for(config), out_file=in_file,
-                      settings=EDIT_SETTINGS, stderr_file=stderr_file)
-    if out_file is not None:
-        model.set_out_file(out_file)
-    return model