cmd2 2.5.8__tar.gz → 2.5.10__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (429) hide show
  1. cmd2-2.5.10/.pre-commit-config.yaml +22 -0
  2. cmd2-2.5.10/.prettierignore +2 -0
  3. cmd2-2.5.10/.prettierrc +10 -0
  4. cmd2-2.5.10/.readthedocs.yaml +26 -0
  5. cmd2-2.5.10/CHANGELOG.md +1423 -0
  6. cmd2-2.5.10/Makefile +67 -0
  7. {cmd2-2.5.8 → cmd2-2.5.10}/PKG-INFO +15 -45
  8. {cmd2-2.5.8 → cmd2-2.5.10}/Pipfile +5 -4
  9. {cmd2-2.5.8 → cmd2-2.5.10}/README.md +9 -6
  10. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/ansi.py +9 -9
  11. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/argparse_completer.py +3 -3
  12. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/argparse_custom.py +19 -33
  13. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/cmd2.py +41 -42
  14. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/command_definition.py +3 -3
  15. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/decorators.py +70 -56
  16. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/history.py +4 -4
  17. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/parsing.py +20 -21
  18. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/py_bridge.py +1 -1
  19. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/table_creator.py +20 -20
  20. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/utils.py +26 -25
  21. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2.egg-info/PKG-INFO +15 -45
  22. cmd2-2.5.10/cmd2.egg-info/SOURCES.txt +356 -0
  23. cmd2-2.5.10/cmd2.egg-info/requires.txt +8 -0
  24. cmd2-2.5.10/docs/api/ansi.md +3 -0
  25. cmd2-2.5.10/docs/api/argparse_completer.md +3 -0
  26. cmd2-2.5.10/docs/api/argparse_custom.md +3 -0
  27. cmd2-2.5.10/docs/api/cmd.md +3 -0
  28. cmd2-2.5.10/docs/api/command_definition.md +3 -0
  29. cmd2-2.5.10/docs/api/constants.md +3 -0
  30. cmd2-2.5.10/docs/api/decorators.md +3 -0
  31. cmd2-2.5.10/docs/api/exceptions.md +3 -0
  32. cmd2-2.5.10/docs/api/history.md +3 -0
  33. cmd2-2.5.10/docs/api/index.md +22 -0
  34. cmd2-2.5.10/docs/api/parsing.md +3 -0
  35. cmd2-2.5.10/docs/api/plugin.md +3 -0
  36. cmd2-2.5.10/docs/api/py_bridge.md +3 -0
  37. cmd2-2.5.10/docs/api/table_creator.md +3 -0
  38. cmd2-2.5.10/docs/api/utils.md +57 -0
  39. cmd2-2.5.10/docs/doc_conventions.md +71 -0
  40. cmd2-2.5.10/docs/examples/alternate_event_loops.md +61 -0
  41. cmd2-2.5.10/docs/examples/examples.md +5 -0
  42. cmd2-2.5.10/docs/examples/first_app.md +238 -0
  43. cmd2-2.5.10/docs/examples/index.md +9 -0
  44. cmd2-2.5.10/docs/features/argument_processing.md +303 -0
  45. cmd2-2.5.10/docs/features/builtin_commands.md +110 -0
  46. cmd2-2.5.10/docs/features/clipboard.md +27 -0
  47. cmd2-2.5.10/docs/features/commands.md +155 -0
  48. cmd2-2.5.10/docs/features/completion.md +85 -0
  49. cmd2-2.5.10/docs/features/disable_commands.md +88 -0
  50. cmd2-2.5.10/docs/features/embedded_python_shells.md +61 -0
  51. cmd2-2.5.10/docs/features/generating_output.md +82 -0
  52. cmd2-2.5.10/docs/features/help.md +169 -0
  53. cmd2-2.5.10/docs/features/history.md +168 -0
  54. cmd2-2.5.10/docs/features/hooks.md +227 -0
  55. cmd2-2.5.10/docs/features/index.md +32 -0
  56. cmd2-2.5.10/docs/features/initialization.md +125 -0
  57. cmd2-2.5.10/docs/features/misc.md +67 -0
  58. cmd2-2.5.10/docs/features/modular_commands.md +305 -0
  59. cmd2-2.5.10/docs/features/multiline_commands.md +17 -0
  60. cmd2-2.5.10/docs/features/os.md +125 -0
  61. cmd2-2.5.10/docs/features/packaging.md +38 -0
  62. cmd2-2.5.10/docs/features/plugins.md +114 -0
  63. cmd2-2.5.10/docs/features/prompt.md +33 -0
  64. cmd2-2.5.10/docs/features/redirection.md +57 -0
  65. cmd2-2.5.10/docs/features/scripting.md +429 -0
  66. cmd2-2.5.10/docs/features/settings.md +117 -0
  67. cmd2-2.5.10/docs/features/shortcuts_aliases_macros.md +80 -0
  68. cmd2-2.5.10/docs/features/startup_commands.md +49 -0
  69. cmd2-2.5.10/docs/features/table_creation.md +17 -0
  70. cmd2-2.5.10/docs/features/transcripts.md +159 -0
  71. cmd2-2.5.10/docs/index.md +68 -0
  72. cmd2-2.5.10/docs/javascripts/readthedocs.js +35 -0
  73. cmd2-2.5.10/docs/migrating/incompatibilities.md +21 -0
  74. cmd2-2.5.10/docs/migrating/index.md +8 -0
  75. cmd2-2.5.10/docs/migrating/minimum.md +41 -0
  76. cmd2-2.5.10/docs/migrating/next_steps.md +25 -0
  77. cmd2-2.5.10/docs/migrating/why.md +30 -0
  78. cmd2-2.5.10/docs/overrides/main.html +3 -0
  79. cmd2-2.5.10/docs/overview/alternatives.md +16 -0
  80. cmd2-2.5.10/docs/overview/index.md +13 -0
  81. cmd2-2.5.10/docs/overview/installation.md +91 -0
  82. cmd2-2.5.10/docs/overview/integrating.md +15 -0
  83. cmd2-2.5.10/docs/overview/resources.md +8 -0
  84. cmd2-2.5.10/docs/plugins/external_test.md +62 -0
  85. cmd2-2.5.10/docs/plugins/index.md +7 -0
  86. cmd2-2.5.10/docs/requirements.txt +7 -0
  87. cmd2-2.5.10/docs/stylesheets/readthedocs.css +11 -0
  88. cmd2-2.5.10/docs/testing.md +39 -0
  89. cmd2-2.5.10/examples/.mypy_cache/3.12/@plugins_snapshot.json +1 -0
  90. cmd2-2.5.10/examples/.mypy_cache/3.12/_ast.data.json +1 -0
  91. cmd2-2.5.10/examples/.mypy_cache/3.12/_ast.meta.json +1 -0
  92. cmd2-2.5.10/examples/.mypy_cache/3.12/_codecs.data.json +1 -0
  93. cmd2-2.5.10/examples/.mypy_cache/3.12/_codecs.meta.json +1 -0
  94. cmd2-2.5.10/examples/.mypy_cache/3.12/_collections_abc.data.json +1 -0
  95. cmd2-2.5.10/examples/.mypy_cache/3.12/_collections_abc.meta.json +1 -0
  96. cmd2-2.5.10/examples/.mypy_cache/3.12/_typeshed/__init__.data.json +1 -0
  97. cmd2-2.5.10/examples/.mypy_cache/3.12/_typeshed/__init__.meta.json +1 -0
  98. cmd2-2.5.10/examples/.mypy_cache/3.12/_typeshed/importlib.data.json +1 -0
  99. cmd2-2.5.10/examples/.mypy_cache/3.12/_typeshed/importlib.meta.json +1 -0
  100. cmd2-2.5.10/examples/.mypy_cache/3.12/abc.data.json +1 -0
  101. cmd2-2.5.10/examples/.mypy_cache/3.12/abc.meta.json +1 -0
  102. cmd2-2.5.10/examples/.mypy_cache/3.12/argparse.data.json +1 -0
  103. cmd2-2.5.10/examples/.mypy_cache/3.12/argparse.meta.json +1 -0
  104. cmd2-2.5.10/examples/.mypy_cache/3.12/builtins.data.json +1 -0
  105. cmd2-2.5.10/examples/.mypy_cache/3.12/builtins.meta.json +1 -0
  106. cmd2-2.5.10/examples/.mypy_cache/3.12/codecs.data.json +1 -0
  107. cmd2-2.5.10/examples/.mypy_cache/3.12/codecs.meta.json +1 -0
  108. cmd2-2.5.10/examples/.mypy_cache/3.12/collections/__init__.data.json +1 -0
  109. cmd2-2.5.10/examples/.mypy_cache/3.12/collections/__init__.meta.json +1 -0
  110. cmd2-2.5.10/examples/.mypy_cache/3.12/collections/abc.data.json +1 -0
  111. cmd2-2.5.10/examples/.mypy_cache/3.12/collections/abc.meta.json +1 -0
  112. cmd2-2.5.10/examples/.mypy_cache/3.12/contextlib.data.json +1 -0
  113. cmd2-2.5.10/examples/.mypy_cache/3.12/contextlib.meta.json +1 -0
  114. cmd2-2.5.10/examples/.mypy_cache/3.12/dataclasses.data.json +1 -0
  115. cmd2-2.5.10/examples/.mypy_cache/3.12/dataclasses.meta.json +1 -0
  116. cmd2-2.5.10/examples/.mypy_cache/3.12/email/__init__.data.json +1 -0
  117. cmd2-2.5.10/examples/.mypy_cache/3.12/email/__init__.meta.json +1 -0
  118. cmd2-2.5.10/examples/.mypy_cache/3.12/email/_policybase.data.json +1 -0
  119. cmd2-2.5.10/examples/.mypy_cache/3.12/email/_policybase.meta.json +1 -0
  120. cmd2-2.5.10/examples/.mypy_cache/3.12/email/charset.data.json +1 -0
  121. cmd2-2.5.10/examples/.mypy_cache/3.12/email/charset.meta.json +1 -0
  122. cmd2-2.5.10/examples/.mypy_cache/3.12/email/contentmanager.data.json +1 -0
  123. cmd2-2.5.10/examples/.mypy_cache/3.12/email/contentmanager.meta.json +1 -0
  124. cmd2-2.5.10/examples/.mypy_cache/3.12/email/errors.data.json +1 -0
  125. cmd2-2.5.10/examples/.mypy_cache/3.12/email/errors.meta.json +1 -0
  126. cmd2-2.5.10/examples/.mypy_cache/3.12/email/header.data.json +1 -0
  127. cmd2-2.5.10/examples/.mypy_cache/3.12/email/header.meta.json +1 -0
  128. cmd2-2.5.10/examples/.mypy_cache/3.12/email/message.data.json +1 -0
  129. cmd2-2.5.10/examples/.mypy_cache/3.12/email/message.meta.json +1 -0
  130. cmd2-2.5.10/examples/.mypy_cache/3.12/email/policy.data.json +1 -0
  131. cmd2-2.5.10/examples/.mypy_cache/3.12/email/policy.meta.json +1 -0
  132. cmd2-2.5.10/examples/.mypy_cache/3.12/enum.data.json +1 -0
  133. cmd2-2.5.10/examples/.mypy_cache/3.12/enum.meta.json +1 -0
  134. cmd2-2.5.10/examples/.mypy_cache/3.12/genericpath.data.json +1 -0
  135. cmd2-2.5.10/examples/.mypy_cache/3.12/genericpath.meta.json +1 -0
  136. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/__init__.data.json +1 -0
  137. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/__init__.meta.json +1 -0
  138. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/_abc.data.json +1 -0
  139. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/_abc.meta.json +1 -0
  140. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/abc.data.json +1 -0
  141. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/abc.meta.json +1 -0
  142. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/machinery.data.json +1 -0
  143. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/machinery.meta.json +1 -0
  144. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/metadata/__init__.data.json +1 -0
  145. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/metadata/__init__.meta.json +1 -0
  146. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/metadata/_meta.data.json +1 -0
  147. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/metadata/_meta.meta.json +1 -0
  148. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/readers.data.json +1 -0
  149. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/readers.meta.json +1 -0
  150. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/resources/__init__.data.json +1 -0
  151. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/resources/__init__.meta.json +1 -0
  152. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/resources/abc.data.json +1 -0
  153. cmd2-2.5.10/examples/.mypy_cache/3.12/importlib/resources/abc.meta.json +1 -0
  154. cmd2-2.5.10/examples/.mypy_cache/3.12/io.data.json +1 -0
  155. cmd2-2.5.10/examples/.mypy_cache/3.12/io.meta.json +1 -0
  156. cmd2-2.5.10/examples/.mypy_cache/3.12/os/__init__.data.json +1 -0
  157. cmd2-2.5.10/examples/.mypy_cache/3.12/os/__init__.meta.json +1 -0
  158. cmd2-2.5.10/examples/.mypy_cache/3.12/os/path.data.json +1 -0
  159. cmd2-2.5.10/examples/.mypy_cache/3.12/os/path.meta.json +1 -0
  160. cmd2-2.5.10/examples/.mypy_cache/3.12/pathlib.data.json +1 -0
  161. cmd2-2.5.10/examples/.mypy_cache/3.12/pathlib.meta.json +1 -0
  162. cmd2-2.5.10/examples/.mypy_cache/3.12/posixpath.data.json +1 -0
  163. cmd2-2.5.10/examples/.mypy_cache/3.12/posixpath.meta.json +1 -0
  164. cmd2-2.5.10/examples/.mypy_cache/3.12/re.data.json +1 -0
  165. cmd2-2.5.10/examples/.mypy_cache/3.12/re.meta.json +1 -0
  166. cmd2-2.5.10/examples/.mypy_cache/3.12/resource.data.json +1 -0
  167. cmd2-2.5.10/examples/.mypy_cache/3.12/resource.meta.json +1 -0
  168. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_compile.data.json +1 -0
  169. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_compile.meta.json +1 -0
  170. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_constants.data.json +1 -0
  171. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_constants.meta.json +1 -0
  172. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_parse.data.json +1 -0
  173. cmd2-2.5.10/examples/.mypy_cache/3.12/sre_parse.meta.json +1 -0
  174. cmd2-2.5.10/examples/.mypy_cache/3.12/subprocess.data.json +1 -0
  175. cmd2-2.5.10/examples/.mypy_cache/3.12/subprocess.meta.json +1 -0
  176. cmd2-2.5.10/examples/.mypy_cache/3.12/sys/__init__.data.json +1 -0
  177. cmd2-2.5.10/examples/.mypy_cache/3.12/sys/__init__.meta.json +1 -0
  178. cmd2-2.5.10/examples/.mypy_cache/3.12/sys/_monitoring.data.json +1 -0
  179. cmd2-2.5.10/examples/.mypy_cache/3.12/sys/_monitoring.meta.json +1 -0
  180. cmd2-2.5.10/examples/.mypy_cache/3.12/types.data.json +1 -0
  181. cmd2-2.5.10/examples/.mypy_cache/3.12/types.meta.json +1 -0
  182. cmd2-2.5.10/examples/.mypy_cache/3.12/typing.data.json +1 -0
  183. cmd2-2.5.10/examples/.mypy_cache/3.12/typing.meta.json +1 -0
  184. cmd2-2.5.10/examples/.mypy_cache/3.12/typing_extensions.data.json +1 -0
  185. cmd2-2.5.10/examples/.mypy_cache/3.12/typing_extensions.meta.json +1 -0
  186. cmd2-2.5.10/examples/.mypy_cache/3.12/zipfile/__init__.data.json +1 -0
  187. cmd2-2.5.10/examples/.mypy_cache/3.12/zipfile/__init__.meta.json +1 -0
  188. cmd2-2.5.10/examples/.mypy_cache/3.12/zipfile/_path.data.json +1 -0
  189. cmd2-2.5.10/examples/.mypy_cache/3.12/zipfile/_path.meta.json +1 -0
  190. cmd2-2.5.10/examples/.mypy_cache/CACHEDIR.TAG +3 -0
  191. cmd2-2.5.10/examples/README.md +88 -0
  192. {cmd2-2.5.8 → cmd2-2.5.10}/examples/argparse_completion.py +1 -1
  193. cmd2-2.5.10/examples/cmd2_history.dat +0 -0
  194. {cmd2-2.5.8 → cmd2-2.5.10}/examples/migrating.py +3 -2
  195. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands/commandset_basic.py +15 -16
  196. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands_main.py +1 -1
  197. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/nested.txt +0 -1
  198. {cmd2-2.5.8 → cmd2-2.5.10}/examples/table_creation.py +3 -3
  199. cmd2-2.5.10/examples/tmux_launch.sh +36 -0
  200. cmd2-2.5.10/examples/tmux_split.sh +34 -0
  201. cmd2-2.5.10/mkdocs.yml +225 -0
  202. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/CHANGELOG.md +8 -6
  203. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/README.md +3 -5
  204. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/README.md +10 -18
  205. {cmd2-2.5.8 → cmd2-2.5.10}/pyproject.toml +71 -114
  206. {cmd2-2.5.8 → cmd2-2.5.10}/readme_files/shout_out.csv +1 -1
  207. {cmd2-2.5.8 → cmd2-2.5.10}/tasks.py +5 -30
  208. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_argparse.py +7 -0
  209. cmd2-2.5.8/.readthedocs.yaml +0 -34
  210. cmd2-2.5.8/CHANGELOG.md +0 -1341
  211. cmd2-2.5.8/cmd2.egg-info/SOURCES.txt +0 -247
  212. cmd2-2.5.8/cmd2.egg-info/requires.txt +0 -46
  213. cmd2-2.5.8/docs/Makefile +0 -89
  214. cmd2-2.5.8/docs/api/ansi.rst +0 -5
  215. cmd2-2.5.8/docs/api/argparse_completer.rst +0 -5
  216. cmd2-2.5.8/docs/api/argparse_custom.rst +0 -35
  217. cmd2-2.5.8/docs/api/cmd.rst +0 -79
  218. cmd2-2.5.8/docs/api/command_definition.rst +0 -5
  219. cmd2-2.5.8/docs/api/constants.rst +0 -29
  220. cmd2-2.5.8/docs/api/decorators.rst +0 -5
  221. cmd2-2.5.8/docs/api/exceptions.rst +0 -20
  222. cmd2-2.5.8/docs/api/history.rst +0 -20
  223. cmd2-2.5.8/docs/api/index.rst +0 -62
  224. cmd2-2.5.8/docs/api/parsing.rst +0 -78
  225. cmd2-2.5.8/docs/api/plugin.rst +0 -45
  226. cmd2-2.5.8/docs/api/plugin_external_test.rst +0 -9
  227. cmd2-2.5.8/docs/api/py_bridge.rst +0 -5
  228. cmd2-2.5.8/docs/api/table_creator.rst +0 -35
  229. cmd2-2.5.8/docs/api/utils.rst +0 -102
  230. cmd2-2.5.8/docs/conf.py +0 -196
  231. cmd2-2.5.8/docs/doc_conventions.rst +0 -228
  232. cmd2-2.5.8/docs/examples/alternate_event_loops.rst +0 -78
  233. cmd2-2.5.8/docs/examples/first_app.rst +0 -323
  234. cmd2-2.5.8/docs/examples/index.rst +0 -8
  235. cmd2-2.5.8/docs/features/argument_processing.rst +0 -377
  236. cmd2-2.5.8/docs/features/builtin_commands.rst +0 -161
  237. cmd2-2.5.8/docs/features/clipboard.rst +0 -41
  238. cmd2-2.5.8/docs/features/commands.rst +0 -224
  239. cmd2-2.5.8/docs/features/completion.rst +0 -151
  240. cmd2-2.5.8/docs/features/disable_commands.rst +0 -103
  241. cmd2-2.5.8/docs/features/embedded_python_shells.rst +0 -93
  242. cmd2-2.5.8/docs/features/generating_output.rst +0 -160
  243. cmd2-2.5.8/docs/features/help.rst +0 -193
  244. cmd2-2.5.8/docs/features/history.rst +0 -269
  245. cmd2-2.5.8/docs/features/hooks.rst +0 -340
  246. cmd2-2.5.8/docs/features/index.rst +0 -32
  247. cmd2-2.5.8/docs/features/initialization.rst +0 -166
  248. cmd2-2.5.8/docs/features/misc.rst +0 -101
  249. cmd2-2.5.8/docs/features/modular_commands.rst +0 -359
  250. cmd2-2.5.8/docs/features/multiline_commands.rst +0 -36
  251. cmd2-2.5.8/docs/features/os.rst +0 -177
  252. cmd2-2.5.8/docs/features/packaging.rst +0 -39
  253. cmd2-2.5.8/docs/features/plugins.rst +0 -159
  254. cmd2-2.5.8/docs/features/prompt.rst +0 -72
  255. cmd2-2.5.8/docs/features/redirection.rst +0 -80
  256. cmd2-2.5.8/docs/features/scripting.rst +0 -523
  257. cmd2-2.5.8/docs/features/settings.rst +0 -188
  258. cmd2-2.5.8/docs/features/shortcuts_aliases_macros.rst +0 -117
  259. cmd2-2.5.8/docs/features/startup_commands.rst +0 -75
  260. cmd2-2.5.8/docs/features/table_creation.rst +0 -40
  261. cmd2-2.5.8/docs/features/transcripts.rst +0 -202
  262. cmd2-2.5.8/docs/index.rst +0 -107
  263. cmd2-2.5.8/docs/make.bat +0 -113
  264. cmd2-2.5.8/docs/migrating/incompatibilities.rst +0 -61
  265. cmd2-2.5.8/docs/migrating/index.rst +0 -14
  266. cmd2-2.5.8/docs/migrating/minimum.rst +0 -51
  267. cmd2-2.5.8/docs/migrating/next_steps.rst +0 -61
  268. cmd2-2.5.8/docs/migrating/summary.rst +0 -15
  269. cmd2-2.5.8/docs/migrating/why.rst +0 -82
  270. cmd2-2.5.8/docs/overview/alternatives.rst +0 -54
  271. cmd2-2.5.8/docs/overview/index.rst +0 -15
  272. cmd2-2.5.8/docs/overview/installation.rst +0 -162
  273. cmd2-2.5.8/docs/overview/integrating.rst +0 -35
  274. cmd2-2.5.8/docs/overview/resources.rst +0 -13
  275. cmd2-2.5.8/docs/overview/summary.rst +0 -22
  276. cmd2-2.5.8/docs/plugins/external_test.rst +0 -82
  277. cmd2-2.5.8/docs/plugins/index.rst +0 -7
  278. cmd2-2.5.8/docs/requirements.txt +0 -8
  279. cmd2-2.5.8/docs/testing.rst +0 -70
  280. {cmd2-2.5.8 → cmd2-2.5.10}/LICENSE +0 -0
  281. {cmd2-2.5.8 → cmd2-2.5.10}/MANIFEST.in +0 -0
  282. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/__init__.py +0 -0
  283. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/clipboard.py +0 -0
  284. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/constants.py +0 -0
  285. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/exceptions.py +0 -0
  286. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/plugin.py +0 -0
  287. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/py.typed +0 -0
  288. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/rl_utils.py +0 -0
  289. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2/transcript.py +0 -0
  290. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2.egg-info/dependency_links.txt +0 -0
  291. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2.egg-info/top_level.txt +0 -0
  292. {cmd2-2.5.8 → cmd2-2.5.10}/cmd2.png +0 -0
  293. {cmd2-2.5.8 → cmd2-2.5.10}/examples/.cmd2rc +0 -0
  294. {cmd2-2.5.8 → cmd2-2.5.10}/examples/alias_startup.py +0 -0
  295. {cmd2-2.5.8 → cmd2-2.5.10}/examples/arg_decorators.py +0 -0
  296. {cmd2-2.5.8 → cmd2-2.5.10}/examples/arg_print.py +0 -0
  297. {cmd2-2.5.8 → cmd2-2.5.10}/examples/async_printing.py +0 -0
  298. {cmd2-2.5.8 → cmd2-2.5.10}/examples/basic.py +0 -0
  299. {cmd2-2.5.8 → cmd2-2.5.10}/examples/basic_completion.py +0 -0
  300. {cmd2-2.5.8 → cmd2-2.5.10}/examples/cmd_as_argument.py +0 -0
  301. {cmd2-2.5.8 → cmd2-2.5.10}/examples/colors.py +0 -0
  302. {cmd2-2.5.8 → cmd2-2.5.10}/examples/custom_parser.py +0 -0
  303. {cmd2-2.5.8 → cmd2-2.5.10}/examples/decorator_example.py +0 -0
  304. {cmd2-2.5.8 → cmd2-2.5.10}/examples/default_categories.py +0 -0
  305. {cmd2-2.5.8 → cmd2-2.5.10}/examples/dynamic_commands.py +0 -0
  306. {cmd2-2.5.8 → cmd2-2.5.10}/examples/environment.py +0 -0
  307. {cmd2-2.5.8 → cmd2-2.5.10}/examples/event_loops.py +0 -0
  308. {cmd2-2.5.8 → cmd2-2.5.10}/examples/example.py +0 -0
  309. {cmd2-2.5.8 → cmd2-2.5.10}/examples/exit_code.py +0 -0
  310. {cmd2-2.5.8 → cmd2-2.5.10}/examples/first_app.py +0 -0
  311. {cmd2-2.5.8 → cmd2-2.5.10}/examples/hello_cmd2.py +0 -0
  312. {cmd2-2.5.8 → cmd2-2.5.10}/examples/help_categories.py +0 -0
  313. {cmd2-2.5.8 → cmd2-2.5.10}/examples/hooks.py +0 -0
  314. {cmd2-2.5.8 → cmd2-2.5.10}/examples/initialization.py +0 -0
  315. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands/__init__.py +0 -0
  316. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands/commandset_complex.py +0 -0
  317. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands/commandset_custominit.py +0 -0
  318. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands_basic.py +0 -0
  319. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_commands_dynamic.py +0 -0
  320. {cmd2-2.5.8 → cmd2-2.5.10}/examples/modular_subcommands.py +0 -0
  321. {cmd2-2.5.8 → cmd2-2.5.10}/examples/override_parser.py +0 -0
  322. {cmd2-2.5.8 → cmd2-2.5.10}/examples/paged_output.py +0 -0
  323. {cmd2-2.5.8 → cmd2-2.5.10}/examples/persistent_history.py +0 -0
  324. {cmd2-2.5.8 → cmd2-2.5.10}/examples/pirate.py +0 -0
  325. {cmd2-2.5.8 → cmd2-2.5.10}/examples/python_scripting.py +0 -0
  326. {cmd2-2.5.8 → cmd2-2.5.10}/examples/read_input.py +0 -0
  327. {cmd2-2.5.8 → cmd2-2.5.10}/examples/remove_builtin_commands.py +0 -0
  328. {cmd2-2.5.8 → cmd2-2.5.10}/examples/remove_settable.py +0 -0
  329. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/arg_printer.py +0 -0
  330. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/conditional.py +0 -0
  331. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/quit.txt +0 -0
  332. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/save_help_text.py +0 -0
  333. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/script.py +0 -0
  334. {cmd2-2.5.8 → cmd2-2.5.10}/examples/scripts/script.txt +0 -0
  335. {cmd2-2.5.8 → cmd2-2.5.10}/examples/subcommands.py +0 -0
  336. {cmd2-2.5.8 → cmd2-2.5.10}/examples/transcripts/exampleSession.txt +0 -0
  337. {cmd2-2.5.8 → cmd2-2.5.10}/examples/transcripts/pirate.transcript +0 -0
  338. {cmd2-2.5.8 → cmd2-2.5.10}/examples/transcripts/quit.txt +0 -0
  339. {cmd2-2.5.8 → cmd2-2.5.10}/examples/transcripts/transcript_regex.txt +0 -0
  340. {cmd2-2.5.8 → cmd2-2.5.10}/examples/unicode_commands.py +0 -0
  341. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/README.txt +0 -0
  342. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/build-pyenvs.sh +0 -0
  343. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/cmd2_ext_test/__init__.py +0 -0
  344. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py +0 -0
  345. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/cmd2_ext_test/py.typed +0 -0
  346. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/cmd2_ext_test/pylintrc +0 -0
  347. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/examples/example.py +0 -0
  348. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/noxfile.py +0 -0
  349. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/pyproject.toml +0 -0
  350. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/setup.py +0 -0
  351. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/tasks.py +0 -0
  352. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/tests/__init__.py +0 -0
  353. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/tests/pylintrc +0 -0
  354. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/ext_test/tests/test_ext_test.py +0 -0
  355. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/tasks.py +0 -0
  356. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/CHANGELOG.md +2 -2
  357. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/LICENSE +0 -0
  358. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/build-pyenvs.sh +0 -0
  359. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/cmd2_myplugin/__init__.py +0 -0
  360. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/cmd2_myplugin/myplugin.py +0 -0
  361. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/cmd2_myplugin/pylintrc +0 -0
  362. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/examples/example.py +0 -0
  363. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/noxfile.py +0 -0
  364. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/setup.py +0 -0
  365. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/tasks.py +0 -0
  366. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/tests/__init__.py +0 -0
  367. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/tests/pylintrc +0 -0
  368. {cmd2-2.5.8 → cmd2-2.5.10}/plugins/template/tests/test_myplugin.py +0 -0
  369. {cmd2-2.5.8 → cmd2-2.5.10}/readme_files/shoutout.txt +0 -0
  370. {cmd2-2.5.8 → cmd2-2.5.10}/setup.cfg +0 -0
  371. {cmd2-2.5.8 → cmd2-2.5.10}/tests/.cmd2rc +0 -0
  372. {cmd2-2.5.8 → cmd2-2.5.10}/tests/__init__.py +0 -0
  373. {cmd2-2.5.8 → cmd2-2.5.10}/tests/conftest.py +0 -0
  374. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/echo.py +0 -0
  375. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/environment.py +0 -0
  376. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/help.py +0 -0
  377. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/py_locals.py +0 -0
  378. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/pyscript_dir.py +0 -0
  379. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/raises_exception.py +0 -0
  380. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/recursive.py +0 -0
  381. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/self_in_py.py +0 -0
  382. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/stdout_capture.py +0 -0
  383. {cmd2-2.5.8 → cmd2-2.5.10}/tests/pyscript/stop.py +0 -0
  384. {cmd2-2.5.8 → cmd2-2.5.10}/tests/relative_multiple.txt +0 -0
  385. {cmd2-2.5.8 → cmd2-2.5.10}/tests/script.py +0 -0
  386. {cmd2-2.5.8 → cmd2-2.5.10}/tests/script.txt +0 -0
  387. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/binary.bin +0 -0
  388. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/empty.txt +0 -0
  389. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/help.txt +0 -0
  390. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/nested.txt +0 -0
  391. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/one_down.txt +0 -0
  392. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/postcmds.txt +0 -0
  393. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/precmds.txt +0 -0
  394. {cmd2-2.5.8 → cmd2-2.5.10}/tests/scripts/utf8.txt +0 -0
  395. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_ansi.py +0 -0
  396. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_argparse_completer.py +0 -0
  397. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_argparse_custom.py +0 -0
  398. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_cmd2.py +0 -0
  399. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_completion.py +0 -0
  400. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_history.py +0 -0
  401. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_parsing.py +0 -0
  402. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_plugin.py +0 -0
  403. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_run_pyscript.py +0 -0
  404. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_table_creator.py +0 -0
  405. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_transcript.py +0 -0
  406. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_utils.py +0 -0
  407. {cmd2-2.5.8 → cmd2-2.5.10}/tests/test_utils_defining_class.py +0 -0
  408. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/bol_eol.txt +0 -0
  409. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/characterclass.txt +0 -0
  410. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/dotstar.txt +0 -0
  411. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/extension_notation.txt +0 -0
  412. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/failure.txt +0 -0
  413. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/from_cmdloop.txt +0 -0
  414. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/multiline_no_regex.txt +0 -0
  415. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/multiline_regex.txt +0 -0
  416. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/no_output.txt +0 -0
  417. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/no_output_last.txt +0 -0
  418. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/regex_set.txt +0 -0
  419. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/singleslash.txt +0 -0
  420. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/slashes_escaped.txt +0 -0
  421. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/slashslash.txt +0 -0
  422. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/spaces.txt +0 -0
  423. {cmd2-2.5.8 → cmd2-2.5.10}/tests/transcripts/word_boundaries.txt +0 -0
  424. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/__init__.py +0 -0
  425. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/test_commandset/__init__.py +0 -0
  426. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/test_commandset/conftest.py +0 -0
  427. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/test_commandset/test_argparse_subcommands.py +0 -0
  428. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/test_commandset/test_categories.py +0 -0
  429. {cmd2-2.5.8 → cmd2-2.5.10}/tests_isolated/test_commandset/test_commandset.py +0 -0
@@ -0,0 +1,22 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: "v5.0.0"
4
+ hooks:
5
+ - id: check-case-conflict
6
+ - id: check-merge-conflict
7
+ - id: end-of-file-fixer
8
+ - id: trailing-whitespace
9
+
10
+ - repo: https://github.com/astral-sh/ruff-pre-commit
11
+ rev: "v0.9.2"
12
+ hooks:
13
+ - id: ruff-format
14
+ args: [--config=pyproject.toml]
15
+
16
+ - repo: https://github.com/pre-commit/mirrors-prettier
17
+ rev: "v3.1.0"
18
+ hooks:
19
+ - id: prettier
20
+ additional_dependencies:
21
+ - prettier@3.4.2
22
+ - prettier-plugin-toml@2.0.1
@@ -0,0 +1,2 @@
1
+ # Markdown documentation files with non-standards syntax for mkdocstrings that Prettier should not auto-format
2
+ docs/features/initialization.md
@@ -0,0 +1,10 @@
1
+ {
2
+ "overrides": [
3
+ {
4
+ "files": "*.md",
5
+ "options": {
6
+ "tabWidth": 4
7
+ }
8
+ }
9
+ ]
10
+ }
@@ -0,0 +1,26 @@
1
+ # Read the Docs configuration file for MkDocs projects
2
+ # See https://docs.readthedocs.io/en/stable/intro/mkdocs.html for details
3
+
4
+ # Required
5
+ version: 2
6
+
7
+ # Optionally build your docs in additional formats such as PDF and ePub
8
+ # formats:
9
+ # - pdf
10
+ # - epub
11
+ formats: all
12
+
13
+ # Build documentation in the "docs/" directory with MkDocs
14
+ mkdocs:
15
+ configuration: mkdocs.yml
16
+
17
+ # Set the OS, Python version and other tools you might need
18
+ build:
19
+ os: ubuntu-24.04
20
+ tools:
21
+ python: "3.13"
22
+ jobs:
23
+ install:
24
+ - pip install .
25
+ - pip install dependency-groups
26
+ - pip-install-dependency-groups docs