ycleptic 2.2.1__tar.gz → 2.2.2__tar.gz

{ycleptic-2.2.1 → ycleptic-2.2.2}/CHANGELOG.md

@@ -5,6 +5,14 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+## [2.2.2] - 2026-08-13
+
+### Added
+- Status badges (PyPI version, supported Python versions, CI, documentation, license) on the README and the documentation landing page
+
+### Fixed
+- Interactive `config-help` no longer ends with an uncaught traceback when stdin reaches EOF (piped or redirected input) or when the user presses Ctrl-C; either case now quits the session cleanly, exactly as if the user had typed `!`
+
 ## [2.2.1] - 2026-07-21
 
 ### Changed

{ycleptic-2.2.1 → ycleptic-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: ycleptic
-Version: 2.2.1
+Version: 2.2.2
 Summary: A YAML-format configuration generator
 Project-URL: Source, https://github.com/cameronabrams/ycleptic
 Project-URL: Documentation, https://ycleptic.readthedocs.io/en/latest/
@@ -48,6 +48,12 @@ Description-Content-Type: text/markdown
 # Ycleptic
 > Self-documenting YAML configuration for Python applications
 
+[![PyPI](https://img.shields.io/pypi/v/ycleptic)](https://pypi.org/project/ycleptic/)
+[![Python versions](https://img.shields.io/pypi/pyversions/ycleptic)](https://pypi.org/project/ycleptic/)
+[![CI](https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml/badge.svg)](https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml)
+[![Documentation Status](https://readthedocs.org/projects/ycleptic/badge/?version=latest)](https://ycleptic.readthedocs.io/en/latest/?badge=latest)
+[![License: MIT](https://img.shields.io/pypi/l/ycleptic)](https://github.com/cameronabrams/ycleptic/blob/main/LICENSE)
+
 One structured YAML file describes your application's configuration schema. From
 that single source of truth, Ycleptic gives you three things that normally live
 in three separate places:

{ycleptic-2.2.1 → ycleptic-2.2.2}/README.md

@@ -1,6 +1,12 @@
 # Ycleptic
 > Self-documenting YAML configuration for Python applications
 
+[![PyPI](https://img.shields.io/pypi/v/ycleptic)](https://pypi.org/project/ycleptic/)
+[![Python versions](https://img.shields.io/pypi/pyversions/ycleptic)](https://pypi.org/project/ycleptic/)
+[![CI](https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml/badge.svg)](https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml)
+[![Documentation Status](https://readthedocs.org/projects/ycleptic/badge/?version=latest)](https://ycleptic.readthedocs.io/en/latest/?badge=latest)
+[![License: MIT](https://img.shields.io/pypi/l/ycleptic)](https://github.com/cameronabrams/ycleptic/blob/main/LICENSE)
+
 One structured YAML file describes your application's configuration schema. From
 that single source of truth, Ycleptic gives you three things that normally live
 in three separate places:

{ycleptic-2.2.1 → ycleptic-2.2.2}/docs/source/index.rst

@@ -1,6 +1,24 @@
 ycleptic
 ========
 
+|pypi| |pyversions| |ci| |docs| |license|
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ycleptic
+   :target: https://pypi.org/project/ycleptic/
+   :alt: PyPI version
+.. |pyversions| image:: https://img.shields.io/pypi/pyversions/ycleptic
+   :target: https://pypi.org/project/ycleptic/
+   :alt: Supported Python versions
+.. |ci| image:: https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml/badge.svg
+   :target: https://github.com/cameronabrams/ycleptic/actions/workflows/ci.yaml
+   :alt: CI status
+.. |docs| image:: https://readthedocs.org/projects/ycleptic/badge/?version=latest
+   :target: https://ycleptic.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation status
+.. |license| image:: https://img.shields.io/pypi/l/ycleptic
+   :target: https://github.com/cameronabrams/ycleptic/blob/main/LICENSE
+   :alt: License: MIT
+
 **Ycleptic** (ee-KLEP-tic) turns a single, structured YAML file into a self-documenting configuration system for your Python application.  From one schema file you get three things at once: validation of a user's config (with defaults, allowed value ``choices``, and required parameters), an automatically generated RST/Sphinx documentation tree, and an interactive help explorer for your users.  Because the schema is data rather than Python code, editing that one file keeps validation, documentation, and help in lockstep.
 
 Ycleptic is intentionally lightweight on validation and focuses on the *spec-as-documentation* workflow — a good fit for scientific and command-line applications whose users are domain experts.  If you need heavyweight validation and coercion, `pydantic <https://docs.pydantic.dev/>`_ or `jsonschema <https://python-jsonschema.readthedocs.io/>`_ are better suited; for composable, hierarchical config, see `Hydra <https://hydra.cc/>`_.

{ycleptic-2.2.1 → ycleptic-2.2.2}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 [project]
 name = "ycleptic"
-version = "2.2.1"
+version = "2.2.2"
 authors = [
   { name="Cameron F Abrams", email="cfa22@drexel.edu" },
 ]

{ycleptic-2.2.1 → ycleptic-2.2.2}/tests/test_set.py

@@ -270,6 +270,42 @@ base|attribute_2->attribute_2a
         with open('console-out.txt', 'r') as f:
             self.assertEqual(f.read(), ref_str)
 
+    def test_console_help_eof_quits_cleanly(self):
+        """EOF on stdin ends an interactive help session as if the user typed '!'."""
+        from unittest.mock import patch
+
+        Y = Yclept(BFILE)
+        with open('console-out.txt', 'w') as f:
+            with redirect_stdout(f):
+                with patch('builtins.input', side_effect=EOFError):
+                    Y.console_help([], interactive_prompt='help: ')
+        with open('console-out.txt', 'r') as f:
+            self.assertIn('! quit', f.read())
+
+    def test_console_help_eof_after_bad_choice_quits_cleanly(self):
+        """EOF also ends the session from the re-prompt after an unrecognized choice."""
+        from unittest.mock import patch
+
+        Y = Yclept(BFILE)
+        with open('console-out.txt', 'w') as f:
+            with redirect_stdout(f):
+                with patch('builtins.input', side_effect=['bogus', EOFError]):
+                    Y.console_help([], interactive_prompt='help: ')
+        with open('console-out.txt', 'r') as f:
+            self.assertIn('bogus not recognized.', f.read())
+
+    def test_console_help_keyboard_interrupt_quits_cleanly(self):
+        """Ctrl-C at the prompt ends the session cleanly rather than raising."""
+        from unittest.mock import patch
+
+        Y = Yclept(BFILE)
+        with open('console-out.txt', 'w') as f:
+            with redirect_stdout(f):
+                with patch('builtins.input', side_effect=KeyboardInterrupt):
+                    Y.console_help([], interactive_prompt='help: ')
+        with open('console-out.txt', 'r') as f:
+            self.assertIn('! quit', f.read())
+
     def test_makedoc(self):
         Y = Yclept(BFILE)
         Y.make_doctree('ydoc')

{ycleptic-2.2.1 → ycleptic-2.2.2}/ycleptic/yclept.py

@@ -201,23 +201,32 @@ class Yclept(UserDict):
                 c = ''
             H.write_func(f'    {m}{c}{a}')
 
+    def _prompt_choice(self):
+        H: Namespace = self.H
+        choice = '!'
+        if H.interactive_prompt != '':
+            try:
+                choice = input(H.interactive_prompt)
+            except (EOFError, KeyboardInterrupt):
+                # no more input, or the user interrupted; quit as though
+                # the user had typed '!'
+                H.write_func('')
+                choice = '!'
+        return choice
+
     def _get_help_choice(self, init_list: list[str]):
         H: Namespace = self.H
         if len(init_list) > 0:
             choice = init_list.pop()
         else:
-            choice = '!'
-            if H.interactive_prompt != '':
-                choice = input(H.interactive_prompt)
+            choice = self._prompt_choice()
         while choice == '' or choice not in [x['name'] for x in H.base] + ['..', '!']:
             if choice != '':
                 H.write_func(f'{choice} not recognized.')
             if len(init_list) > 0:
                 choice = init_list.pop()
             else:
-                choice = '!'
-                if H.interactive_prompt != '':
-                    choice = input(H.interactive_prompt)
+                choice = self._prompt_choice()
         return choice
 
     def _help(self):