Merge pull request #61 from mpkocher/run-exit-overload

Migrate to a Cmd interface with 6.0.0. Backwards incompatible.
mpkocher · Jul 25, 2024 · 51ccf76 · 51ccf76
2 parents 587a341 + 3450eb8
commit 51ccf76
Show file tree

Hide file tree

Showing 37 changed files with 456 additions and 532 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,16 @@
 # CHANGELOG
 
+## Version 6.0.0
+
+- Backwards incompatible change. Use `Cmd` model.
+- Remove "*sp*" specific functions. No longer necessary because of Cmd interface.
+- To migrate forward, inherit from `Cmd` and put your "main" function as `Cmd.run` method.
+- `Cmd.run()` should return None (on success) or raise an exception on error.
+
 ## Version 5.0.0 (Pydantic 2 support)
 
+(Not published)
+
 - Support for Pydantic >= 2.8
 - Pydantic 2 has a different "optional" definition
 - Use `CliConfig` instead of `DefaultConfig`