Skip to content

Commit 332afb6

Browse files
authored
Add info on the cmd2-ansi and cmd2-table backport migration aid modules to documentation and CHANGELOG (#1524)
Add info on the cmd2-ansi and cmd2-table backport migration aid modules to documentation and CHANGELOG (#1524) Also: - Upgrade ruff to 0.13.2
1 parent f6ee875 commit 332afb6

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ repos:
99
- id: trailing-whitespace
1010

1111
- repo: https://github.com/astral-sh/ruff-pre-commit
12-
rev: "v0.13.1"
12+
rev: "v0.13.2"
1313
hooks:
1414
- id: ruff-format
1515
args: [--config=ruff.toml]

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ time reading the [rich documentation](https://rich.readthedocs.io/).
5252
- Fixed a redirection bug where `cmd2` could unintentionally overwrite an application's
5353
`sys.stdout`
5454

55+
- Migration Aids - these will help you iteratively migrate to `cmd2` 3.x in stages
56+
- Published new [cmd2-ansi](https://pypi.org/project/cmd2-ansi/) module which is a backport of
57+
the `cmd2.ansi` module present in `cmd2` 2.7.0
58+
- Published new [cmd2-table](https://pypi.org/project/cmd2-table/) module which is a backport of
59+
the `cmd2.table_creator` module present in `cmd2` 2.7.0
60+
5561
## 2.7.0 (June 30, 2025)
5662

5763
- Enhancements

docs/upgrades.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ The functionality within the `cmd2.ansi` module has either been removed or chang
2020
`rich` and moved to one of the new modules: [cmd2.string_utils][], [cmd2.styles][], or
2121
[cmd2.terminal_utils][].
2222

23+
To ease the migration path from `cmd2` 2.x to 3.x, we have created the `cmd2-ansi` module which is a
24+
backport of the `cmd2.ansi` module present in `cmd2` 2.7.0 in a standalone fashion. Relevant links:
25+
26+
- PyPI: [cmd2-ansi](https://pypi.org/project/cmd2-ansi/)
27+
- GitHub: [cmd2-ansi](https://github.com/python-cmd2/cmd2-ansi)
28+
29+
To use this backport:
30+
31+
```Python
32+
from cmd2_ansi import ansi
33+
```
34+
2335
#### table_creator
2436

2537
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.
3143
offered. We apologize for this backwards incompatibility, but the APIs were fundamentally different
3244
and we could not figure out a way to create a backwards-compatibility wrapper.
3345

46+
To ease the migration path from `cmd2` 2.x to 3.x, we have created the `cmd2-table` module which is
47+
a backport of the `cmd2.table_creator` module present in `cmd2` 2.7.0 in a standalone fashion.
48+
Relevant links:
49+
50+
- PyPI: [cmd2-table](https://pypi.org/project/cmd2-table/)
51+
- GitHub: [cmd2-table](https://github.com/python-cmd2/cmd2-table)
52+
53+
To use this backport:
54+
55+
```Python
56+
from cmd2_table import table_creator
57+
```
58+
3459
### Added modules
3560

3661
#### colors

0 commit comments

Comments
 (0)