cmd2 2.7.0__tar.gz → 3.0.0__tar.gz

{cmd2-2.7.0 → cmd2-3.0.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v5.0.0"
+    rev: "v6.0.0"
     hooks:
       - id: check-case-conflict
       - id: check-merge-conflict
@@ -9,17 +9,17 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.12.0"
+    rev: "v0.14.8"
     hooks:
       - id: ruff-format
-        args: [--config=pyproject.toml]
+        args: [--config=ruff.toml]
       - id: ruff-check
-        args: [--config=pyproject.toml, --fix, --exit-non-zero-on-fix]
+        args: [--config=ruff.toml, --fix, --exit-non-zero-on-fix]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.1.0"
     hooks:
       - id: prettier
         additional_dependencies:
-          - prettier@3.5.3
-          - prettier-plugin-toml@2.0.5
+          - prettier@3.6.2
+          - prettier-plugin-toml@2.0.6

{cmd2-2.7.0 → cmd2-3.0.0}/CHANGELOG.md

@@ -1,3 +1,75 @@
+## 3.0.0 (December 7, 2025)
+
+### Summary
+
+`cmd2` now has a dependency on [rich](https://github.com/Textualize/rich) for rich text and pretty
+formatting in the terminal. Previously, `cmd2` had a large amount of custom code for this purpose
+that predated the existence of `rich`. This opens the door to even more beautiful `cmd2`
+applications. To get the most out of the new capabilities, we encourage you to spend a little bit of
+time reading the [rich documentation](https://rich.readthedocs.io/).
+
+### Details
+
+- Breaking Changes
+    - Refactored and modernized styling and utility modules:
+        - Removed the legacy `table_creator.py` module in favor of `rich` tables (see the
+          [rich_tables.py](https://github.com/python-cmd2/cmd2/blob/main/examples/rich_tables.py)
+          example for more info)
+        - Moved all string-related functions from `utils.py` to a new `string_utils.py` module
+            - Removed redundant `string` from some of the names so `quote_string` is now just
+              `quote` and `quote_string_if_needed` is now `quote_if_needed`
+        - Consolidated all string styling functions from `ansi.py` into `string_utils.py`
+        - Replaced all text style enums from `ansi.py` with modern `rich` styles
+        - Renamed `ansi.py` to `terminal_utils.py` to better reflect its purpose
+    - Dropped support for Python 3.9. `cmd2` now requires Python 3.10 or later
+    - Replaced `Settable.get_value()` and `Settable.set_value()` methods with a more Pythonic
+      `value` property
+    - Removed redundant setting of a parser's `prog` value in the `with_argparser()` decorator, as
+      this is now handled centrally in `Cmd._build_parser()`
+    - The `auto_load_commands` argument to `cmd2.Cmd.__init__` now defaults to `False`
+    - `argparse_custom` module breaking changes:
+        - `descriptive_header: str` replaced with `descriptive_headers: Sequence[str | rich.Column]`
+            - Applies to parameter name when adding an argument to a parser as well as
+              `set_descriptive_headers` and `get_descriptive_headers`
+        - `CompletionItem.description: str` changed to
+          `CompletionItem.descriptive_data: Sequence[str | rich.Column]`
+    - `decorators` module breaking changes:
+        - `_set_parser_prog` renamed to `set_parser_prog` (without the leading underscore) and moved
+          to `argparse_custom` module
+    - Renamed history `--output_file` to `--output-file` to follow common command-line practices
+
+- Enhancements
+    - Enhanced all print methods (`poutput()`, `perror()`, `ppaged()`, etc.) to natively render
+      `rich` objects, enabling beautiful and complex output
+    - Simplified the process for setting a custom parser for `cmd2`'s built-in commands. See the
+      [custom_parser.py](https://github.com/python-cmd2/cmd2/blob/main/examples/custom_parser.py)
+      example for an updated guide
+    - Introduced `Cmd.macro_arg_complete()` for tab-completing macro arguments, with default path
+      completion that can be easily customized
+    - Added `colors.py` and `styles.py` to provide easy access to `rich` color names and manage
+      `cmd2`-specific style definitions using `StrEnum` (see the
+      [colors.py](https://github.com/python-cmd2/cmd2/blob/main/examples/color.py) example for a
+      demonstration of all colors available to your `cmd2` application)
+    - Added ability to create a custom theme for a `cmd2` application using `rich_utils.set_theme`
+      (see the [rich_theme.py](https://github.com/python-cmd2/cmd2/blob/main/examples/rich_theme.py)
+      example for more info)
+    - Consolidated multiple redundant examples into a few more comprehensive ones, see:
+        - [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/main/examples/argparse_example.py)
+        - [command_sets.py](https://github.com/python-cmd2/cmd2/blob/main/examples/command_sets.py)
+        - [getting_started.py](https://github.com/python-cmd2/cmd2/blob/main/examples/getting_started.py)
+    - Optimized performance of terminal fixup during command finalization by replacing `stty sane`
+      with `termios.tcsetattr`
+
+- Bug Fixes
+    - Fixed a redirection bug where `cmd2` could unintentionally overwrite an application's
+      `sys.stdout`
+
+- Migration Aids - these will help you iteratively migrate to `cmd2` 3.x in stages
+    - Published new [cmd2-ansi](https://pypi.org/project/cmd2-ansi/) module which is a backport of
+      the `cmd2.ansi` module present in `cmd2` 2.7.0
+    - Published new [cmd2-table](https://pypi.org/project/cmd2-table/) module which is a backport of
+      the `cmd2.table_creator` module present in `cmd2` 2.7.0
+
 ## 2.7.0 (June 30, 2025)
 
 - Enhancements
@@ -6,7 +78,6 @@
 ## 2.6.2 (June 26, 2025)
 
 - Enhancements
-
     - Added explicit support for free-threaded versions of Python, starting with version 3.14
 
 - Bug Fixes
@@ -101,7 +172,7 @@
       prompts.
         - This fix introduces behavior where an updated prompt won't display after an aborted search
           until a user presses Enter. See
-          [async_printing.py](https://github.com/python-cmd2/cmd2/blob/master/examples/async_printing.py)
+          [async_printing.py](https://github.com/python-cmd2/cmd2/blob/main/examples/async_printing.py)
           example for how to handle this case using `Cmd.need_prompt_refresh()` and
           `Cmd.async_refresh_prompt()`.
 - Enhancements
@@ -321,8 +392,8 @@
       persistent history files created with versions older than 2.0.0 are not compatible.
 - Enhancements
     - Added support for custom tab completion and up-arrow input history to `cmd2.Cmd2.read_input`.
-      See [read_input.py](https://github.com/python-cmd2/cmd2/blob/master/examples/read_input.py)
-      for an example.
+      See [read_input.py](https://github.com/python-cmd2/cmd2/blob/main/examples/read_input.py) for
+      an example.
     - Added `cmd2.exceptions.PassThroughException` to raise unhandled command exceptions instead of
       printing them.
     - Added support for ANSI styles and newlines in tab completion results using
@@ -534,7 +605,7 @@
         - See [table_creation](https://cmd2.readthedocs.io/en/latest/features/table_creation.html)
           documentation for an overview.
         - See
-          [table_creation.py](https://github.com/python-cmd2/cmd2/blob/master/examples/table_creation.py)
+          [table_creation.py](https://github.com/python-cmd2/cmd2/blob/main/examples/table_creation.py)
           for an example.
     - Added the following exceptions to the public API
         - `SkipPostcommandHooks` - Custom exception class for when a command has a failure bad
@@ -786,7 +857,7 @@
     - Greatly simplified using argparse-based tab completion. The new interface is a complete
       overhaul that breaks the previous way of specifying completion and choices functions. See
       header of
-      [argparse_custom.py](https://github.com/python-cmd2/cmd2/blob/master/cmd2/argparse_custom.py)
+      [argparse_custom.py](https://github.com/python-cmd2/cmd2/blob/main/cmd2/argparse_custom.py)
       for more information.
     - Enabled tab completion on multiline commands
 - **Renamed Commands Notice**
@@ -1109,7 +1180,7 @@
     - Added `async_alert`, `async_update_prompt`, and `set_window_title` functions
         - These allow you to provide feedback to the user in an asynchronous fashion, meaning alerts
           can display when the user is still entering text at the prompt. See
-          [async_printing.py](https://github.com/python-cmd2/cmd2/blob/master/examples/async_printing.py)
+          [async_printing.py](https://github.com/python-cmd2/cmd2/blob/main/examples/async_printing.py)
           for an example.
     - Cross-platform colored output support
         - `colorama` gets initialized properly in `Cmd.__init()`
@@ -1147,7 +1218,7 @@
     - New dependency on `attrs` third party module
     - Added `matches_sorted` member to support custom sorting of tab completion matches
     - Added
-      [tab_autocomp_dynamic.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocomp_dynamic.py)
+      [tab_autocomp_dynamic.py](https://github.com/python-cmd2/cmd2/blob/main/examples/tab_autocomp_dynamic.py)
       example
         - Demonstrates updating the argparse object during init instead of during class construction
 - Deprecations
@@ -1190,7 +1261,7 @@
         - If `chop` is `False`, then `self.pager` is used as the pager
         - Otherwise `self.pager_chop` is used as the pager
     - Greatly improved the
-      [table_display.py](https://github.com/python-cmd2/cmd2/blob/master/examples/table_display.py)
+      [table_display.py](https://github.com/python-cmd2/cmd2/blob/main/examples/table_display.py)
       example
         - Now uses the new [tableformatter](https://github.com/python-tableformatter/tableformatter)
           module which looks better than `tabulate`
@@ -1224,7 +1295,7 @@
 - Enhancements
     - Automatic completion of `argparse` arguments via `cmd2.argparse_completer.AutoCompleter`
         - See the
-          [tab_autocompletion.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocompletion.py)
+          [tab_autocompletion.py](https://github.com/python-cmd2/cmd2/blob/main/examples/tab_autocompletion.py)
           example for a demonstration of how to use this feature
     - `cmd2` no longer depends on the `six` module
     - `cmd2` is now a multi-file Python package instead of a single-file module
@@ -1262,7 +1333,7 @@
           [Argument Processing](http://cmd2.readthedocs.io/en/latest/argument_processing.html)
           section of the documentation for more information on these decorators
         - Alternatively, see the
-          [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/master/examples/argparse_example.py)
+          [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/main/examples/argparse_example.py)
     - Deleted `cmd_with_subs_completer`, `get_subcommands`, and `get_subcommand_completer`
         - Replaced by default AutoCompleter implementation for all commands using argparse
     - Deleted support for old method of calling application commands with `cmd()` and `self`
@@ -1292,12 +1363,10 @@
 ## 0.8.5 (April 15, 2018)
 
 - Bug Fixes
-
     - Fixed a bug with all argument decorators where the wrapped function wasn't returning a value
       and thus couldn't cause the cmd2 app to quit
 
 - Enhancements
-
     - Added support for verbose help with -v where it lists a brief summary of what each command
       does
     - Added support for categorizing commands into groups within the help menu
@@ -1305,7 +1374,7 @@
           [Grouping Commands](http://cmd2.readthedocs.io/en/latest/argument_processing.html?highlight=verbose#grouping-commands)
           section of the docs for more info
         - See
-          [help_categories.py](https://github.com/python-cmd2/cmd2/blob/master/examples/help_categories.py)
+          [help_categories.py](https://github.com/python-cmd2/cmd2/blob/main/examples/help_categories.py)
           for an example
     - Tab completion of paths now supports ~user user path expansion
     - Simplified implementation of various tab completion functions so they no longer require
@@ -1329,12 +1398,10 @@
 ## 0.8.3 (April 09, 2018)
 
 - Bug Fixes
-
     - Fixed `help` command not calling functions for help topics
     - Fixed not being able to use quoted paths when redirecting with `<` and `>`
 
 - Enhancements
-
     - Tab completion has been overhauled and now supports completion of strings with quotes and
       spaces.
     - Tab completion will automatically add an opening quote if a string with a space is completed.
@@ -1357,8 +1424,8 @@
     - `cmd_with_subs_completer()` no longer takes an argument called `base`. Adding tab completion
       to subcommands has been simplified to declaring it in the subcommand parser's default
       settings. This easily allows arbitrary completers like path_complete to be used. See
-      [subcommands.py](https://github.com/python-cmd2/cmd2/blob/master/examples/subcommands.py) for
-      an example of how to use tab completion in subcommands. In addition, the docstring for
+      [subcommands.py](https://github.com/python-cmd2/cmd2/blob/main/examples/subcommands.py) for an
+      example of how to use tab completion in subcommands. In addition, the docstring for
       `cmd_with_subs_completer()` offers more details.
 
 ## 0.8.2 (March 21, 2018)
@@ -1376,12 +1443,12 @@
       attribute to enable canceling current line instead of quitting when Ctrl+C is typed
     - Added possibility of having readline history preservation in a SubMenu
     - Added
-      [table_display.py](https://github.com/python-cmd2/cmd2/blob/master/examples/table_display.py)
+      [table_display.py](https://github.com/python-cmd2/cmd2/blob/main/examples/table_display.py)
       example to demonstrate how to display tabular data
     - Added command aliasing with `alias` and `unalias` commands
     - Added the ability to load an initialization script at startup
         - See
-          [alias_startup.py](https://github.com/python-cmd2/cmd2/blob/master/examples/alias_startup.py)
+          [alias_startup.py](https://github.com/python-cmd2/cmd2/blob/main/examples/alias_startup.py)
           for an example
     - Added a default SIGINT handler which terminates any open pipe subprocesses and re-raises a
       KeyboardInterrupt
@@ -1394,14 +1461,14 @@
     - Fixed a bug in a unit test which would fail if your home directory was empty on a Linux system
     - Fixed outdated help text for the **edit** command
     - Fixed outdated
-      [remove_unused.py](https://github.com/python-cmd2/cmd2/blob/master/examples/remove_unused.py)
+      [remove_unused.py](https://github.com/python-cmd2/cmd2/blob/main/examples/remove_unused.py)
 - Enhancements
     - Added support for sub-menus.
-        - See [submenus.py](https://github.com/python-cmd2/cmd2/blob/master/examples/submenus.py)
-          for an example of how to use it
+        - See [submenus.py](https://github.com/python-cmd2/cmd2/blob/main/examples/submenus.py) for
+          an example of how to use it
     - Added option for persistent readline history
         - See
-          [persistent_history.py](https://github.com/python-cmd2/cmd2/blob/master/examples/persistent_history.py)
+          [persistent_history.py](https://github.com/python-cmd2/cmd2/blob/main/examples/persistent_history.py)
           for an example
         - See the
           [Searchable command history](http://cmd2.readthedocs.io/en/latest/freefeatures.html#searchable-command-history)
@@ -1412,10 +1479,10 @@
     - `exclude_from_help` and `excludeFromHistory` are now instance instead of class attributes
     - Added flag and index based tab completion helper functions
         - See
-          [tab_completion.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_completion.py)
+          [tab_completion.py](https://github.com/python-cmd2/cmd2/blob/main/examples/tab_completion.py)
     - Added support for displaying output which won't fit on the screen via a pager using `ppaged()`
         - See
-          [paged_output.py](https://github.com/python-cmd2/cmd2/blob/master/examples/paged_output.py)
+          [paged_output.py](https://github.com/python-cmd2/cmd2/blob/main/examples/paged_output.py)
 - Attributes Removed (**can cause breaking changes**)
     - `abbrev` - Removed support for abbreviated commands
         - Good tab completion makes this unnecessary and its presence could cause harmful unintended
@@ -1442,13 +1509,13 @@
     - See the [Argument Processing](http://cmd2.readthedocs.io/en/latest/argument_processing.html)
       section of the documentation for more information on these decorators
         - Alternatively, see the
-          [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/master/examples/argparse_example.py)
-          and [arg_print.py](https://github.com/python-cmd2/cmd2/blob/master/examples/arg_print.py)
+          [argparse_example.py](https://github.com/python-cmd2/cmd2/blob/main/examples/argparse_example.py)
+          and [arg_print.py](https://github.com/python-cmd2/cmd2/blob/main/examples/arg_print.py)
           examples
     - Added support for Argparse subcommands when using the **with_argument_parser** or \*
       \*with_argparser_and_unknown_args\*\* decorators
         - See
-          [subcommands.py](https://github.com/python-cmd2/cmd2/blob/master/examples/subcommands.py)
+          [subcommands.py](https://github.com/python-cmd2/cmd2/blob/main/examples/subcommands.py)
           for an example of how to use subcommands
         - Tab completion of subcommand names is automatically supported
     - The **\_\_relative_load** command is now hidden from the help menu by default

cmd2-3.0.0/GEMINI.md

@@ -0,0 +1,38 @@
+# Instructions for Gemini CLI in a `uv` Python project
+
+This `GEMINI.md` file provides context and instructions for the Gemini CLI when working with this
+Python project, which utilizes `uv` for environment and package management.
+
+## General Instructions
+
+- **Environment Management:** Prefer using `uv` for all Python environment management tasks.
+- **Package Installation:** Always use `uv` to install packages and ensure they are installed within
+  the project's virtual environment.
+- **Running Scripts/Commands:**
+    - To run Python scripts within the project's virtual environment, use `uv run ...`.
+    - To run programs directly from a PyPI package (installing it on the fly if necessary), use
+      `uvx ...` (shortcut for `uv tool run`).
+- **New Dependencies:** If a new dependency is required, please state the reason for its inclusion.
+
+## Python Code Standards
+
+To ensure Python code adheres to required standards, the following commands **must** be run before
+creating or modifying any `.py` files:
+
+```bash
+make check
+```
+
+To run unit tests use the following command:
+
+```bash
+make test
+```
+
+To make sure the documentation builds properly, use the following command:
+
+```bash
+make docs-test
+```
+
+All 3 of the above commands should be run prior to committing code.

{cmd2-2.7.0 → cmd2-3.0.0}/MANIFEST.in

@@ -1,4 +1,4 @@
-include LICENSE README.md CHANGELOG.md mkdocs.yml pyproject.toml tasks.py
+include LICENSE README.md CHANGELOG.md mkdocs.yml pyproject.toml ruff.toml tasks.py
 recursive-include examples *
 recursive-include tests *
 recursive-include docs *

{cmd2-2.7.0 → cmd2-3.0.0}/Makefile

@@ -2,8 +2,8 @@
 .PHONY: install
 install: ## Install the virtual environment with dependencies
 	@echo "🚀 Creating uv Python virtual environment"
-	@uv python install 3.13
-	@uv sync --python=3.13
+	@uv python install 3.14
+	@uv sync --python=3.14
 	@echo "🚀 Installing Git pre-commit hooks locally"
 	@uv run pre-commit install
 	@echo "🚀 Installing Prettier using npm"
@@ -33,8 +33,7 @@ typecheck: ## Perform type checking
 .PHONY: test
 test: ## Test the code with pytest.
 	@echo "🚀 Testing code: Running pytest"
-	@uv run python -m pytest --cov --cov-config=pyproject.toml --cov-report=xml tests
-	@uv run python -m pytest --cov --cov-config=pyproject.toml --cov-report=xml tests_isolated
+	@uv run python -Xutf8 -m pytest --cov --cov-config=pyproject.toml --cov-report=xml tests
 
 .PHONY: docs-test
 docs-test: ## Test if documentation can be built without warnings or errors

{cmd2-2.7.0 → cmd2-3.0.0}/PKG-INFO

@@ -1,61 +1,40 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 2.7.0
+Version: 3.0.0
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
-License: The MIT License (MIT)
-        
-        Copyright (c) 2008-2025 Catherine Devlin and others
-        
-        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.
-        
+License-Expression: MIT
 Keywords: CLI,cmd,command,interactive,prompt,Python
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: backports.strenum; python_version == "3.10"
 Requires-Dist: gnureadline>=8; platform_system == "Darwin"
-Requires-Dist: pyperclip>=1.8
+Requires-Dist: pyperclip>=1.8.2
 Requires-Dist: pyreadline3>=3.4; platform_system == "Windows"
+Requires-Dist: rich>=14.1.0
 Requires-Dist: rich-argparse>=1.7.1
-Requires-Dist: wcwidth>=0.2.10
 Dynamic: license-file
 
 <h1 align="center">cmd2 : immersive interactive command line applications</h1>
 
 [![Latest Version](https://img.shields.io/pypi/v/cmd2.svg?style=flat-square&label=latest%20stable%20version)](https://pypi.python.org/pypi/cmd2/)
 [![GitHub Actions](https://github.com/python-cmd2/cmd2/workflows/CI/badge.svg)](https://github.com/python-cmd2/cmd2/actions?query=workflow%3ACI)
-[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
+[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/main/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
 [![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
 <a href="https://discord.gg/RpVG6tk"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
 
@@ -69,7 +48,7 @@ Dynamic: license-file
   <a href="#projects-using-cmd2">Projects using cmd2</a> •
 </p>
 
-[![Screenshot](https://raw.githubusercontent.com/python-cmd2/cmd2/master/cmd2.png)](https://youtu.be/DDU_JH6cFsA)
+[![Screenshot](https://raw.githubusercontent.com/python-cmd2/cmd2/main/cmd2.png)](https://youtu.be/DDU_JH6cFsA)
 
 cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it
 quick and easy for developers to build feature-rich and user-friendly interactive command line
@@ -78,9 +57,14 @@ applications. It provides a simple API which is an extension of Python's built-i
 of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
 when using cmd.
 
+> :warning: **`cmd2` 3.0.0 has been released and there are some significant backwards
+> incompatibilities from version `2.x`. Please see the
+> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from
+> `cmd2` 2.x to 3.x.**
+
 ## The developers toolbox
 
-![system schema](https://raw.githubusercontent.com/python-cmd2/cmd2/master/.github/images/graph.drawio.png)
+![system schema](https://raw.githubusercontent.com/python-cmd2/cmd2/main/.github/images/graph.drawio.png)
 
 When creating solutions developers have no shortage of tools to create rich and smart user
 interfaces. System administrators have long been duct taping together brittle workflows based on a
@@ -88,7 +72,7 @@ menagerie of simple command line tools created by strangers on github and the gu
 Unfortunately, when CLIs become significantly complex the ease of command discoverability tends to
 fade quickly. On the other hand, Web and traditional desktop GUIs are first in class when it comes
 to easily discovering functionality. The price we pay for beautifully colored displays is complexity
-required to aggregate disperate applications into larger systems. `cmd2` fills the niche between
+required to aggregate disparate applications into larger systems. `cmd2` fills the niche between
 high [ease of command discovery](https://clig.dev/#ease-of-discovery) applications and smart
 workflow automation systems.
 
@@ -136,7 +120,7 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
 pip install -U cmd2
 ```
 
-cmd2 works with Python 3.9+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
+cmd2 works with Python 3.10+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
 dependencies. It works with both conventional CPython and free-threaded variants.
 
 For information on other installation options, see
@@ -154,20 +138,16 @@ examples.
 
 ## Tutorials
 
-- PyOhio 2019 presentation:
-    - [video](https://www.youtube.com/watch?v=pebeWrTqIIw)
-    - [slides](https://github.com/python-cmd2/talks/blob/master/PyOhio_2019/cmd2-PyOhio_2019.pdf)
-    - [example code](https://github.com/python-cmd2/talks/tree/master/PyOhio_2019/examples)
+- [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/main/examples)
+    - Basic cmd2 examples to demonstrate how to use various features
+- [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
+    - More complex examples that demonstrate more featuers about how to put together a complete
+      application
 - [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
     - Basic cookiecutter template for cmd2 application :
       https://github.com/jayrod/cookiecutter-python-cmd2
     - Advanced cookiecutter template with external plugin support :
       https://github.com/jayrod/cookiecutter-python-cmd2-ext-plug
-- [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/master/examples)
-    - Basic cmd2 examples to demonstrate how to use various features
-- [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
-    - More complex examples that demonstrate more featuers about how to put together a complete
-      application
 
 ## Hello World
 
@@ -180,9 +160,8 @@ import cmd2
 class FirstApp(cmd2.Cmd):
     """A simple cmd2 application."""
 
-
-def do_hello_world(self, _: cmd2.Statement):
-    self.poutput('Hello World')
+    def do_hello_world(self, _: cmd2.Statement):
+        self.poutput('Hello World')
 
 
 if __name__ == '__main__':
@@ -224,6 +203,7 @@ reproduce the bug. At a minimum, please state the following:
 | [tomcatmanager](https://github.com/tomcatmanager/tomcatmanager) | A command line tool and python library for managing a tomcat server                                                             | [tomcatmanager](https://github.com/tomcatmanager)                     |
 | [Falcon Toolkit](https://github.com/CrowdStrike/Falcon-Toolkit) | Unleash the power of the CrowdStrike Falcon Platform at the CLI                                                                 | [CrowdStrike](https://github.com/CrowdStrike)                         |
 | [EXPLIoT](https://gitlab.com/expliot_framework/expliot)         | Internet of Things Security Testing and Exploitation framework                                                                  | [expliot_framework](https://gitlab.com/expliot_framework/)            |
+| [Pobshell](https://github.com/pdalloz/pobshell)                 | A Bash‑like shell for live Python objects: `cd`, `ls`, `cat`, `find` and _CLI piping_ for object code, str values & more        | [Peter Dalloz](https://www.linkedin.com/in/pdalloz)                   |
 
 Possibly defunct but still good examples
 

{cmd2-2.7.0 → cmd2-3.0.0}/README.md

@@ -2,7 +2,7 @@
 
 [![Latest Version](https://img.shields.io/pypi/v/cmd2.svg?style=flat-square&label=latest%20stable%20version)](https://pypi.python.org/pypi/cmd2/)
 [![GitHub Actions](https://github.com/python-cmd2/cmd2/workflows/CI/badge.svg)](https://github.com/python-cmd2/cmd2/actions?query=workflow%3ACI)
-[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
+[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/main/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
 [![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
 <a href="https://discord.gg/RpVG6tk"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
 
@@ -16,7 +16,7 @@
   <a href="#projects-using-cmd2">Projects using cmd2</a> •
 </p>
 
-[![Screenshot](https://raw.githubusercontent.com/python-cmd2/cmd2/master/cmd2.png)](https://youtu.be/DDU_JH6cFsA)
+[![Screenshot](https://raw.githubusercontent.com/python-cmd2/cmd2/main/cmd2.png)](https://youtu.be/DDU_JH6cFsA)
 
 cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it
 quick and easy for developers to build feature-rich and user-friendly interactive command line
@@ -25,9 +25,14 @@ applications. It provides a simple API which is an extension of Python's built-i
 of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
 when using cmd.
 
+> :warning: **`cmd2` 3.0.0 has been released and there are some significant backwards
+> incompatibilities from version `2.x`. Please see the
+> [Migration Guide](https://cmd2.readthedocs.io/en/latest/upgrades/) for tips on upgrading from
+> `cmd2` 2.x to 3.x.**
+
 ## The developers toolbox
 
-![system schema](https://raw.githubusercontent.com/python-cmd2/cmd2/master/.github/images/graph.drawio.png)
+![system schema](https://raw.githubusercontent.com/python-cmd2/cmd2/main/.github/images/graph.drawio.png)
 
 When creating solutions developers have no shortage of tools to create rich and smart user
 interfaces. System administrators have long been duct taping together brittle workflows based on a
@@ -35,7 +40,7 @@ menagerie of simple command line tools created by strangers on github and the gu
 Unfortunately, when CLIs become significantly complex the ease of command discoverability tends to
 fade quickly. On the other hand, Web and traditional desktop GUIs are first in class when it comes
 to easily discovering functionality. The price we pay for beautifully colored displays is complexity
-required to aggregate disperate applications into larger systems. `cmd2` fills the niche between
+required to aggregate disparate applications into larger systems. `cmd2` fills the niche between
 high [ease of command discovery](https://clig.dev/#ease-of-discovery) applications and smart
 workflow automation systems.
 
@@ -83,7 +88,7 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
 pip install -U cmd2
 ```
 
-cmd2 works with Python 3.9+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
+cmd2 works with Python 3.10+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party
 dependencies. It works with both conventional CPython and free-threaded variants.
 
 For information on other installation options, see
@@ -101,20 +106,16 @@ examples.
 
 ## Tutorials
 
-- PyOhio 2019 presentation:
-    - [video](https://www.youtube.com/watch?v=pebeWrTqIIw)
-    - [slides](https://github.com/python-cmd2/talks/blob/master/PyOhio_2019/cmd2-PyOhio_2019.pdf)
-    - [example code](https://github.com/python-cmd2/talks/tree/master/PyOhio_2019/examples)
+- [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/main/examples)
+    - Basic cmd2 examples to demonstrate how to use various features
+- [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
+    - More complex examples that demonstrate more featuers about how to put together a complete
+      application
 - [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
     - Basic cookiecutter template for cmd2 application :
       https://github.com/jayrod/cookiecutter-python-cmd2
     - Advanced cookiecutter template with external plugin support :
       https://github.com/jayrod/cookiecutter-python-cmd2-ext-plug
-- [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/master/examples)
-    - Basic cmd2 examples to demonstrate how to use various features
-- [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
-    - More complex examples that demonstrate more featuers about how to put together a complete
-      application
 
 ## Hello World
 
@@ -127,9 +128,8 @@ import cmd2
 class FirstApp(cmd2.Cmd):
     """A simple cmd2 application."""
 
-
-def do_hello_world(self, _: cmd2.Statement):
-    self.poutput('Hello World')
+    def do_hello_world(self, _: cmd2.Statement):
+        self.poutput('Hello World')
 
 
 if __name__ == '__main__':
@@ -171,6 +171,7 @@ reproduce the bug. At a minimum, please state the following:
 | [tomcatmanager](https://github.com/tomcatmanager/tomcatmanager) | A command line tool and python library for managing a tomcat server                                                             | [tomcatmanager](https://github.com/tomcatmanager)                     |
 | [Falcon Toolkit](https://github.com/CrowdStrike/Falcon-Toolkit) | Unleash the power of the CrowdStrike Falcon Platform at the CLI                                                                 | [CrowdStrike](https://github.com/CrowdStrike)                         |
 | [EXPLIoT](https://gitlab.com/expliot_framework/expliot)         | Internet of Things Security Testing and Exploitation framework                                                                  | [expliot_framework](https://gitlab.com/expliot_framework/)            |
+| [Pobshell](https://github.com/pdalloz/pobshell)                 | A Bash‑like shell for live Python objects: `cd`, `ls`, `cat`, `find` and _CLI piping_ for object code, str values & more        | [Peter Dalloz](https://www.linkedin.com/in/pdalloz)                   |
 
 Possibly defunct but still good examples