From ca0552f6107880e0c83c5d70d453887d603ce3c8 Mon Sep 17 00:00:00 2001
From: Todd Leonhardt <todd.leonhardt@gmail.com>
Date: Fri, 26 Sep 2025 01:00:49 -0400
Subject: [PATCH] Add info on the cmd2-ansi and cmd2-table backport migration
 aid modules to documentation and CHANGELOG

Also:
- Upgrade ruff to 0.13.2
---
 .pre-commit-config.yaml |  2 +-
 CHANGELOG.md            |  6 ++++++
 docs/upgrades.md        | 25 +++++++++++++++++++++++++
 3 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 1c003e9d..e6f90998 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -9,7 +9,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.13.1"
+    rev: "v0.13.2"
     hooks:
       - id: ruff-format
         args: [--config=ruff.toml]
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8f2090b5..2fa9d62a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -52,6 +52,12 @@ time reading the [rich documentation](https://rich.readthedocs.io/).
     - 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
diff --git a/docs/upgrades.md b/docs/upgrades.md
index f8a31326..7c26afac 100644
--- a/docs/upgrades.md
+++ b/docs/upgrades.md
@@ -20,6 +20,18 @@ The functionality within the `cmd2.ansi` module has either been removed or chang
 `rich` and moved to one of the new modules: [cmd2.string_utils][], [cmd2.styles][], or
 [cmd2.terminal_utils][].
 
+To ease the migration path from `cmd2` 2.x to 3.x, we have created the `cmd2-ansi` module which is a
+backport of the `cmd2.ansi` module present in `cmd2` 2.7.0 in a standalone fashion. Relevant links:
+
+- PyPI: [cmd2-ansi](https://pypi.org/project/cmd2-ansi/)
+- GitHub: [cmd2-ansi](https://github.com/python-cmd2/cmd2-ansi)
+
+To use this backport:
+
+```Python
+from cmd2_ansi import ansi
+```
+
 #### table_creator
 
 The `cmd2.table_creator` module no longer exists. Please see rich's documentation on
@@ -31,6 +43,19 @@ demonstrates how to use `rich` tables in a `cmd2` application.
 offered. We apologize for this backwards incompatibility, but the APIs were fundamentally different
 and we could not figure out a way to create a backwards-compatibility wrapper.
 
+To ease the migration path from `cmd2` 2.x to 3.x, we have created the `cmd2-table` module which is
+a backport of the `cmd2.table_creator` module present in `cmd2` 2.7.0 in a standalone fashion.
+Relevant links:
+
+- PyPI: [cmd2-table](https://pypi.org/project/cmd2-table/)
+- GitHub: [cmd2-table](https://github.com/python-cmd2/cmd2-table)
+
+To use this backport:
+
+```Python
+from cmd2_table import table_creator
+```
+
 ### Added modules
 
 #### colors