backlogops-cli 0.7__tar.gz → 0.9__tar.gz

{backlogops_cli-0.7 → backlogops_cli-0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: backlogops-cli
-Version: 0.7
+Version: 0.9
 Summary: Command line interface for backlog operations.
 Author: Tom Björkholm
 Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -23,9 +23,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: argcomplete>=3.7.1
-Requires-Dist: backlogops>=0.7
-Requires-Dist: wizard-ui-bridge[textual]>=1.2
+Requires-Dist: argcomplete>=3.7.2
+Requires-Dist: backlogops>=0.9
+Requires-Dist: wizard-ui-bridge[textual]>=1.3
+Requires-Dist: edit-cfg-json-textual==0.0.2
 Requires-Dist: versionreporter>=0.4
 Dynamic: author
 Dynamic: license-file
@@ -248,6 +249,9 @@ backlogops_cli serves 2 purposes:
   python3 -m backlogops_cli.adjust_release_content
      Adjust release content to fit the planned release dates
 
+  python3 -m backlogops_cli.config_edit
+     Edit a configuration file in a full-screen editor
+
   python3 -m backlogops_cli.config_wizard
      Create a backlog-ops configuration file via a wizard
 
@@ -318,10 +322,10 @@ backlogops_cli serves 2 purposes:
 
 ## Test summary
 
-- Test result: 2453 passed, 9 deselected in 38s
+- Test result: 2232 passed, 1 deselected in 44s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.7
-- Build and test using Python 3.14.6
+- Built version(s): 0.9
+- Build and test using Python 3.14.7

{backlogops_cli-0.7 → backlogops_cli-0.9}/README_pypi.md

@@ -214,6 +214,9 @@ backlogops_cli serves 2 purposes:
   python3 -m backlogops_cli.adjust_release_content
      Adjust release content to fit the planned release dates
 
+  python3 -m backlogops_cli.config_edit
+     Edit a configuration file in a full-screen editor
+
   python3 -m backlogops_cli.config_wizard
      Create a backlog-ops configuration file via a wizard
 
@@ -284,10 +287,10 @@ backlogops_cli serves 2 purposes:
 
 ## Test summary
 
-- Test result: 2453 passed, 9 deselected in 38s
+- Test result: 2232 passed, 1 deselected in 44s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.7
-- Build and test using Python 3.14.6
+- Built version(s): 0.9
+- Build and test using Python 3.14.7

{backlogops_cli-0.7 → backlogops_cli-0.9}/backlogops_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: backlogops-cli
-Version: 0.7
+Version: 0.9
 Summary: Command line interface for backlog operations.
 Author: Tom Björkholm
 Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
@@ -23,9 +23,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: argcomplete>=3.7.1
-Requires-Dist: backlogops>=0.7
-Requires-Dist: wizard-ui-bridge[textual]>=1.2
+Requires-Dist: argcomplete>=3.7.2
+Requires-Dist: backlogops>=0.9
+Requires-Dist: wizard-ui-bridge[textual]>=1.3
+Requires-Dist: edit-cfg-json-textual==0.0.2
 Requires-Dist: versionreporter>=0.4
 Dynamic: author
 Dynamic: license-file
@@ -248,6 +249,9 @@ backlogops_cli serves 2 purposes:
   python3 -m backlogops_cli.adjust_release_content
      Adjust release content to fit the planned release dates
 
+  python3 -m backlogops_cli.config_edit
+     Edit a configuration file in a full-screen editor
+
   python3 -m backlogops_cli.config_wizard
      Create a backlog-ops configuration file via a wizard
 
@@ -318,10 +322,10 @@ backlogops_cli serves 2 purposes:
 
 ## Test summary
 
-- Test result: 2453 passed, 9 deselected in 38s
+- Test result: 2232 passed, 1 deselected in 44s
 - No flake8 warnings.
 - No mypy errors found.
 - No pylint warnings.
 - No python layout warnings.
-- Built version(s): 0.7
-- Build and test using Python 3.14.6
+- Built version(s): 0.9
+- Build and test using Python 3.14.7

{backlogops_cli-0.7 → backlogops_cli-0.9}/backlogops_cli.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ src/backlogops_cli/add_releases_to_jira.py
 src/backlogops_cli/add_to_jira.py
 src/backlogops_cli/adjust_release_content.py
 src/backlogops_cli/bloc_version_reporter.py
+src/backlogops_cli/config_edit.py
 src/backlogops_cli/config_wizard.py
 src/backlogops_cli/convert.py
 src/backlogops_cli/demo_backlog.py

backlogops_cli-0.9/backlogops_cli.egg-info/requires.txt

@@ -0,0 +1,5 @@
+argcomplete>=3.7.2
+backlogops>=0.9
+wizard-ui-bridge[textual]>=1.3
+edit-cfg-json-textual==0.0.2
+versionreporter>=0.4

{backlogops_cli-0.7 → backlogops_cli-0.9}/setup.py

@@ -5,7 +5,7 @@ from setuptools import setup
 
 setup(
   name='backlogops-cli',
-  version='0.7',
+  version='0.9',
   description='Command line interface for backlog operations.',
   author='Tom Björkholm',
   author_email='klausuler_linnet0q@icloud.com',
@@ -14,9 +14,10 @@ setup(
   package_dir={'backlogops_cli': 'src/backlogops_cli'},
   package_data={'backlogops_cli': ['src/py.typed']},
   install_requires=[
-    'argcomplete >= 3.7.1',
-    'backlogops >= 0.7',
-    'wizard-ui-bridge[textual] >= 1.2',
+    'argcomplete >= 3.7.2',
+    'backlogops >= 0.9',
+    'wizard-ui-bridge[textual] >= 1.3',
+    'edit-cfg-json-textual == 0.0.2',
     'versionreporter >= 0.4'
   ]
 )

{backlogops_cli-0.7 → backlogops_cli-0.9}/src/backlogops_cli/_command_io.py

@@ -17,12 +17,14 @@ from pathlib import Path
 from collections.abc import Callable
 from typing import Optional, TextIO, TypeVar
 import argcomplete
+from config_as_json import Config
 from backlogops_cli._migrate_warn import (
     CliMigrateWarnHook, CliPresetMigrateWarnHook)
 from backlogops_cli.bloc_version_reporter import BloCliVersionReporter
 from backlogops import (
     BacklogOpsConfig, BacklogReleases, FileExistsCb, FormatRules,
-    JiraRankAnchor, Levels, ReleaseChanges, ReleaseDateChanges,
+    InputFormatConfig, JiraRankAnchor, Levels, OutputFormatConfig,
+    ReleaseChanges, ReleaseDateChanges,
     allow_overwrite, format_content_changes, format_date_changes,
     get_backlog_ops_config, read_backlog_releases, resolve_input_config,
     resolve_output_config, write_backlog_releases, write_content_changes,
@@ -38,6 +40,31 @@ RANK_ANCHOR_CHOICES = {
     'last-key': JiraRankAnchor.LAST_KEY}
 """Command-line anchor names mapped to :class:`JiraRankAnchor` members."""
 
+KIND_CLASSES: dict[str, type[Config]] = {
+    'config': BacklogOpsConfig, 'input': InputFormatConfig,
+    'output': OutputFormatConfig}
+"""Map a ``--kind`` value to the configuration class it names.
+
+Shared by every command that is told which kind of configuration file it is
+given, so that the migrate and the edit command cannot come to mean
+different things by one kind name.
+"""
+
+
+def add_kind_arg(parser: argparse.ArgumentParser) -> None:
+    """Add the ``-k``/``--kind`` option saying what the input file is."""
+    parser.add_argument('-k', '--kind', dest='kind', default='config',
+                        choices=sorted(KIND_CLASSES),
+                        help="What the input file is: 'config' (default, a "
+                        "backlog-ops configuration file), 'input' (an input "
+                        "format preset file), or 'output' (an output format "
+                        'preset file).')
+
+
+def kind_class(parsed: argparse.Namespace) -> type[Config]:
+    """Return the configuration class the ``--kind`` value names."""
+    return KIND_CLASSES[parsed.kind]
+
 
 def rank_anchor(value: Optional[str]) -> Optional[JiraRankAnchor]:
     """Return the anchor for a CLI anchor name, or None for a None value."""

{backlogops_cli-0.7 → backlogops_cli-0.9}/src/backlogops_cli/_wizard_io.py

@@ -23,10 +23,9 @@ from config_as_json import Config
 from config_as_json.file_extension import fix_file_extension
 from wizard_ui_bridge import WizardUiBridge, WizardUiBridgeConsole, \
     make_text_ui_bridge
-from backlogops import safe_write_config
+from backlogops import CONFIG_EXTENSION, safe_write_config
 from backlogops_cli._command_io import add_force_arg, overwrite_callback
 
-CONFIG_EXTENSION = '.cfg'
 _ConfigT = TypeVar('_ConfigT', bound=Config)
 
 

backlogops_cli-0.9/src/backlogops_cli/config_edit.py

@@ -0,0 +1,115 @@
+#! /usr/local/bin/python3
+"""Edit a configuration file in a full-screen terminal editor.
+
+The whole configuration is shown at once, folded where it is deep, so a
+single value can be changed without walking through every question the
+wizard asks. The editor is the one of ``edit-cfg-json-textual``, so it needs
+a terminal; where the input is redirected, the wizard command is the way in.
+
+``-i`` says which file to edit and ``-k``/``--kind`` what kind of file it
+is: the backlog-ops configuration, or a stand-alone input or output preset.
+Without ``-o`` the file that was read is the file that Save writes, which is
+what an editor is normally asked to do; with ``-o`` the input file is left
+alone. Saving validates the whole configuration through its own class first
+and refuses to write values the library would not read back, and what it
+writes over is kept as that name plus ``.bak``.
+"""
+
+# PYTHON_ARGCOMPLETE_OK
+# Copyright (c) 2026, Tom Björkholm
+# MIT License
+
+import argparse
+import sys
+from pathlib import Path
+from typing import Optional
+from config_as_json.file_extension import fix_file_extension
+from edit_cfg_json import EditModel
+from edit_cfg_json_textual import TextualEditor
+from backlogops import (
+    CONFIG_EXTENSION, default_edit_config, edit_model_for)
+from backlogops_cli._command_io import add_kind_arg, kind_class, parsed_args
+
+DESCRIPTION = 'Edit a configuration file in a full-screen editor'
+
+EDIT_ERRORS = (ValueError, TypeError, KeyError, OSError)
+"""Errors raised when the file to edit cannot be opened."""
+
+
+def build_parser() -> argparse.ArgumentParser:
+    """Build the command line parser for the config edit command."""
+    parser = argparse.ArgumentParser(description=DESCRIPTION)
+    parser.add_argument('-i', '--input', dest='input', required=True,
+                        help='Existing configuration file to edit. The '
+                        f'{CONFIG_EXTENSION} extension is assumed when the '
+                        'file is not found as named.')
+    parser.add_argument('-o', '--output', dest='output',
+                        help='Configuration file that Save writes. Without '
+                        '-o the edited file is written, which leaves no '
+                        f'second copy behind. The {CONFIG_EXTENSION} '
+                        'extension is added to a name that has none.')
+    add_kind_arg(parser)
+    return parser
+
+
+def _input_file(parsed: argparse.Namespace) -> str:
+    """Return the file to edit, assuming the extension when needed.
+
+    Raises:
+        ValueError: Neither the given name nor the completed one is a file.
+    """
+    path = fix_file_extension(parsed.input, CONFIG_EXTENSION, for_reading=True)
+    if not Path(path).is_file():
+        raise ValueError(f'Configuration file to edit not found: {path}')
+    return path
+
+
+def _model_to_edit(parsed: argparse.Namespace) -> EditModel:
+    """Return the edit model for the file and kind that were asked for.
+
+    Raises:
+        ValueError: The file cannot be found or cannot be opened for
+            editing, or the class cannot be constructed.
+    """
+    return edit_model_for(default_edit_config(kind_class(parsed)),
+                          in_file=_input_file(parsed), out_file=parsed.output,
+                          stderr_file=sys.stderr)
+
+
+def _report(model: EditModel) -> int:
+    """Print what the session wrote, and answer with the exit code.
+
+    Closing an editor is not a failure, so a session that saved nothing
+    still succeeds; it says so, because a user who meant to save would
+    otherwise be told nothing at all. What a save did is the editor's own
+    message, which names the file it wrote and where what it wrote over is.
+    """
+    if model.saved_config is None:
+        print('Closed without saving.')
+        return 0
+    print(model.save_message)
+    return 0
+
+
+def main(args: Optional[list[str]] = None) -> int:
+    """Open the configuration file in the editor and report what was saved.
+
+    Args:
+        args: Optional replacement for ``sys.argv[1:]``, mainly for tests.
+
+    Returns:
+        ``0`` when the session ran, whether or not anything was saved,
+        ``1`` when the file cannot be opened for editing.
+    """
+    parsed = parsed_args(build_parser(), args)
+    try:
+        model = _model_to_edit(parsed)
+    except EDIT_ERRORS as error:
+        print(f'Could not open the configuration: {error}', file=sys.stderr)
+        return 1
+    TextualEditor().run_editor(model)
+    return _report(model)
+
+
+if __name__ == '__main__':  # pragma: no cover
+    sys.exit(main())

{backlogops_cli-0.7 → backlogops_cli-0.9}/src/backlogops_cli/migrate_cfg.py

@@ -17,18 +17,11 @@ existing output file, so the destination must not exist.
 import argparse
 import sys
 from typing import Optional
-from config_as_json import Config, migrate_cfg
-from backlogops import (
-    BacklogOpsConfig, InputFormatConfig, OutputFormatConfig)
-from backlogops_cli._command_io import parsed_args
+from config_as_json import migrate_cfg
+from backlogops_cli._command_io import add_kind_arg, kind_class, parsed_args
 
 DESCRIPTION = 'Migrate a configuration file to the current file format'
 
-KIND_CLASSES: dict[str, type[Config]] = {
-    'config': BacklogOpsConfig, 'input': InputFormatConfig,
-    'output': OutputFormatConfig}
-"""Map a ``--kind`` value to the configuration class used to migrate it."""
-
 MIGRATE_ERRORS = (ValueError, TypeError, KeyError, OSError)
 """Errors raised when an input file cannot be read or written."""
 
@@ -41,12 +34,7 @@ def build_parser() -> argparse.ArgumentParser:
     parser.add_argument('-o', '--output', dest='output', required=True,
                         help='New configuration file to create. It must '
                         'not already exist.')
-    parser.add_argument('-k', '--kind', dest='kind', default='config',
-                        choices=sorted(KIND_CLASSES),
-                        help="What the input file is: 'config' (default, a "
-                        "backlog-ops configuration file), 'input' (an input "
-                        "format preset file), or 'output' (an output format "
-                        'preset file).')
+    add_kind_arg(parser)
     return parser
 
 
@@ -66,9 +54,8 @@ def main(args: Optional[list[str]] = None) -> int:
         already exists, or the data cannot be written.
     """
     parsed = parsed_args(build_parser(), args)
-    config_class = KIND_CLASSES[parsed.kind]
     try:
-        migrate_cfg(parsed.input, parsed.output, config_class)
+        migrate_cfg(parsed.input, parsed.output, kind_class(parsed))
     except SystemExit as error:
         return _exit_code(error)
     except MIGRATE_ERRORS as error:

backlogops_cli-0.7/backlogops_cli.egg-info/requires.txt

@@ -1,4 +0,0 @@
-argcomplete>=3.7.1
-backlogops>=0.7
-wizard-ui-bridge[textual]>=1.2
-versionreporter>=0.4