cmd2 2.4.3__py3-none-any.whl → 2.5.9__py3-none-any.whl

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.
@@ -1,226 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: cmd2
3
- Version: 2.4.3
4
- Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
5
- Home-page: https://github.com/python-cmd2/cmd2
6
- Author: Catherine Devlin
7
- Author-email: catherine.devlin@gmail.com
8
- License: MIT
9
- Keywords: command prompt console cmd
10
- Platform: any
11
- Classifier: Development Status :: 5 - Production/Stable
12
- Classifier: Environment :: Console
13
- Classifier: Operating System :: OS Independent
14
- Classifier: Intended Audience :: Developers
15
- Classifier: Intended Audience :: System Administrators
16
- Classifier: License :: OSI Approved :: MIT License
17
- Classifier: Programming Language :: Python
18
- Classifier: Programming Language :: Python :: 3
19
- Classifier: Programming Language :: Python :: 3.6
20
- Classifier: Programming Language :: Python :: 3.7
21
- Classifier: Programming Language :: Python :: 3.8
22
- Classifier: Programming Language :: Python :: 3.9
23
- Classifier: Programming Language :: Python :: 3.10
24
- Classifier: Programming Language :: Python :: Implementation :: CPython
25
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
26
- Requires-Python: >=3.6
27
- Description-Content-Type: text/markdown
28
- License-File: LICENSE
29
- Requires-Dist: attrs (>=16.3.0)
30
- Requires-Dist: pyperclip (>=1.6)
31
- Requires-Dist: wcwidth (>=0.1.7)
32
- Requires-Dist: importlib-metadata (>=1.6.0) ; python_version < "3.8"
33
- Requires-Dist: typing-extensions ; python_version < "3.8"
34
- Requires-Dist: pyreadline3 ; sys_platform=='win32'
35
- Provides-Extra: dev
36
- Requires-Dist: codecov ; extra == 'dev'
37
- Requires-Dist: doc8 ; extra == 'dev'
38
- Requires-Dist: flake8 ; extra == 'dev'
39
- Requires-Dist: invoke ; extra == 'dev'
40
- Requires-Dist: mypy ; extra == 'dev'
41
- Requires-Dist: nox ; extra == 'dev'
42
- Requires-Dist: pytest (>=4.6) ; extra == 'dev'
43
- Requires-Dist: pytest-cov ; extra == 'dev'
44
- Requires-Dist: pytest-mock ; extra == 'dev'
45
- Requires-Dist: sphinx ; extra == 'dev'
46
- Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
47
- Requires-Dist: sphinx-autobuild ; extra == 'dev'
48
- Requires-Dist: twine (>=1.11) ; extra == 'dev'
49
- Provides-Extra: test
50
- Requires-Dist: codecov ; extra == 'test'
51
- Requires-Dist: coverage ; extra == 'test'
52
- Requires-Dist: pytest (>=4.6) ; extra == 'test'
53
- Requires-Dist: pytest-cov ; extra == 'test'
54
- Requires-Dist: pytest-mock ; extra == 'test'
55
- Requires-Dist: gnureadline ; (sys_platform == "darwin") and extra == 'test'
56
- Provides-Extra: validate
57
- Requires-Dist: flake8 ; extra == 'validate'
58
- Requires-Dist: mypy ; extra == 'validate'
59
- Requires-Dist: types-pkg-resources ; extra == 'validate'
60
-
61
- <h1 align="center">cmd2 : immersive interactive command line applications</h1>
62
-
63
- [![Latest Version](https://img.shields.io/pypi/v/cmd2.svg?style=flat-square&label=latest%20stable%20version)](https://pypi.python.org/pypi/cmd2/)
64
- [![GitHub Actions](https://github.com/python-cmd2/cmd2/workflows/CI/badge.svg)](https://github.com/python-cmd2/cmd2/actions?query=workflow%3ACI)
65
- [![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
66
- [![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
67
- <a href="https://discord.gg/RpVG6tk"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
68
-
69
-
70
- <p align="center">
71
- <a href="#the-developers-toolbox">Develper's Toolbox</a> •
72
- <a href="#philosophy">Philosophy</a> •
73
- <a href="#installation">Installation</a> •
74
- <a href="#documentation">Documentation</a> •
75
- <a href="#tutorials">Tutorials</a> •
76
- <a href="#hello-world">Hello World</a> •
77
- <a href="#projects-using-cmd2">Projects using cmd2</a> •
78
- </p>
79
-
80
- [![Screenshot](https://raw.githubusercontent.com/python-cmd2/cmd2/master/cmd2.png)](https://youtu.be/DDU_JH6cFsA)
81
-
82
- cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it
83
- quick and easy for developers to build feature-rich and user-friendly interactive command line
84
- applications. It provides a simple API which is an extension of Python's built-in
85
- [cmd](https://docs.python.org/3/library/cmd.html) module. cmd2 provides a wealth of features on top
86
- of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
87
- when using cmd.
88
-
89
- The developers toolbox
90
- ----------------------
91
-
92
- ![system schema](https://raw.githubusercontent.com/python-cmd2/cmd2/master/.github/images/graph.drawio.png)
93
-
94
-
95
- When creating solutions developers have no shortage of tools to create rich and smart user interfaces.
96
- System administrators have long been duct taping together brittle workflows based on a menagerie of simple command line tools created by strangers on github and the guy down the hall.
97
- Unfortunately, when CLIs become significantly complex the ease of command discoverability tends to fade quickly.
98
- On the other hand, Web and traditional desktop GUIs are first in class when it comes to easily discovering functionality.
99
- The price we pay for beautifully colored displays is complexity required to aggregate disperate applications into larger systems.
100
- `cmd2` fills the niche between high [ease of command discovery](https://clig.dev/#ease-of-discovery) applications and smart workflow automation systems.
101
-
102
- The `cmd2` framework provides a great mixture of both worlds. Application designers can easily create complex applications and rely on the cmd2 library to offer effortless user facing help and extensive tab completion.
103
- When users become comfortable with functionality, cmd2 turns into a feature rich library enabling a smooth transition to full automation. If designed with enough forethought, a well implemented cmd2 application can serve as a boutique workflow tool. `cmd2` pulls off this flexibility based on two pillars of philosophy:
104
-
105
- * Tab Completion
106
- * Automation Transition
107
-
108
- Philosophy
109
- -------------
110
-
111
- <a href="https://imgflip.com/i/63h03x"><img src="https://i.imgflip.com/63h03x.jpg" title="made at imgflip.com" width="70%" height="%70"/></a>
112
-
113
-
114
- Deep extensive tab completion and help text generation based on the argparse library create the first pillar of 'ease of command discovery'. The following is a list of features in this category.
115
-
116
- - Great tab completion of commands, subcommands, file system paths, and shell commands.
117
- - Custom tab completion for user designed commands via simple function overloading.
118
- - Tab completion from `persistent_history_file` sources added with very little friction.
119
- - Automatic tab completion of `argparse` flags and optional arguments.
120
- - Path completion easily enabled.
121
- - When all else fails, custom tab completion based on `choices_provider` can fill any gaps.
122
-
123
- <a href="https://imgflip.com/i/66t0y0"><img src="https://i.imgflip.com/66t0y0.jpg" title="made at imgflip.com" width="70%" height="70%"/></a>
124
-
125
- cmd2 creates the second pillar of 'ease of transition to automation' through alias/macro creation, command line argument parsing and execution of cmd2 scripting.
126
-
127
- - Flexible alias and macro creation for quick abstraction of commands.
128
- - Text file scripting of your application with `run_script` (`@`) and `_relative_run_script` (`@@`)
129
- - Powerful and flexible built-in Python scripting of your application using the `run_pyscript` command
130
- - Transcripts for use with built-in regression can be automatically generated from `history -t` or `run_script -t`
131
-
132
-
133
- Installation
134
- ------------
135
- On all operating systems, the latest stable version of `cmd2` can be installed using pip:
136
-
137
- ```bash
138
- pip install -U cmd2
139
- ```
140
-
141
- cmd2 works with Python 3.6+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party dependencies.
142
-
143
- For information on other installation options, see
144
- [Installation Instructions](https://cmd2.readthedocs.io/en/latest/overview/installation.html) in the cmd2
145
- documentation.
146
-
147
-
148
- Documentation
149
- -------------
150
- The latest documentation for cmd2 can be read online here: https://cmd2.readthedocs.io/en/latest/
151
-
152
- It is available in HTML, PDF, and ePub formats.
153
-
154
-
155
- The best way to learn the cmd2 api is to delve into the example applications located in source under examples.
156
-
157
- Tutorials
158
- ---------
159
-
160
- * PyOhio 2019 presentation:
161
- * [video](https://www.youtube.com/watch?v=pebeWrTqIIw)
162
- * [slides](https://github.com/python-cmd2/talks/blob/master/PyOhio_2019/cmd2-PyOhio_2019.pdf)
163
- * [example code](https://github.com/python-cmd2/talks/tree/master/PyOhio_2019/examples)
164
- * [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
165
- * Basic cookiecutter template for cmd2 application : https://github.com/jayrod/cookiecutter-python-cmd2
166
- * Advanced cookiecutter template with external plugin support : https://github.com/jayrod/cookiecutter-python-cmd2-ext-plug
167
- * [Example Applications](https://github.com/jayrod/cmd2-example-apps)
168
-
169
-
170
- Hello World
171
- -----------
172
-
173
- ```python
174
- #!/usr/bin/env python
175
- """A simple cmd2 application."""
176
- import cmd2
177
-
178
-
179
- class FirstApp(cmd2.Cmd):
180
- """A simple cmd2 application."""
181
-
182
- def do_hello_world(self, _: cmd2.Statement):
183
- self.poutput('Hello World')
184
-
185
- if __name__ == '__main__':
186
- import sys
187
- c = FirstApp()
188
- sys.exit(c.cmdloop())
189
-
190
- ```
191
-
192
-
193
- Found a bug?
194
- ------------
195
-
196
- If you think you've found a bug, please first read through the open [Issues](https://github.com/python-cmd2/cmd2/issues). If you're confident it's a new bug, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug. At a minimum, please state the following:
197
-
198
- * ``cmd2`` version
199
- * Python version
200
- * OS name and version
201
- * What you did to cause the bug to occur
202
- * Include any traceback or error message associated with the bug
203
-
204
-
205
- Projects using cmd2
206
- -------------------------------
207
-
208
- | Application Name | Description | |
209
- |-----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|---|
210
- | [Jok3r](http://www.jok3r-framework.com) | Network & Web Pentest Automation Framework | |
211
- | [CephFS Shell](https://github.com/ceph/ceph) | [Ceph](https://ceph.com/) is a distributed object, block, and file storage platform | |
212
- | [psiTurk](https://psiturk.org) | An open platform for science on Amazon Mechanical Turk | |
213
- | [Poseidon](https://github.com/CyberReboot/poseidon) | Leverages software-defined networks (SDNs) to acquire and then feed network traffic to a number of machine learning techniques. | |
214
- | [Unipacker](https://github.com/unipacker/unipacker) | Automatic and platform-independent unpacker for Windows binaries based on emulation | |
215
- | [tomcatmanager](https://github.com/tomcatmanager/tomcatmanager) | A command line tool and python library for managing a tomcat server | |
216
- | [Expliot](https://gitlab.com/expliot_framework/expliot) | Internet of Things (IoT) exploitation framework | |
217
- | [mptcpanalyzer]() | Tool to help analyze mptcp pcaps | |
218
- | [clanvas](https://github.com/marklalor/clanvas) | Command-line client for Canvas by Instructure | |
219
-
220
-
221
- Possibly defunct but still good examples
222
-
223
- * [JSShell](https://github.com/Den1al/JSShell)
224
- * [FLASHMINGO](https://github.com/fireeye/flashmingo)
225
-
226
-
@@ -1,24 +0,0 @@
1
- cmd2/__init__.py,sha256=kyKimWJ0rCDXub-faObNgvknbvc7owO7WtGY3fCDmBk,2723
2
- cmd2/ansi.py,sha256=Ccg7Uwwe7XyipH1V1PoTypkB5iNfIvS2aAdiOfIWSpk,32075
3
- cmd2/argparse_completer.py,sha256=WIZnY20LjbxPxdUsY_u7jvws_zgA5EGVf2Pr1S4x93I,36642
4
- cmd2/argparse_custom.py,sha256=AaeYYsNcMEZD0LPtrxhesh9e0U3JPDj-YaO5Y7ebsQU,58859
5
- cmd2/clipboard.py,sha256=bLPn44J1qPREpd1PleiRw3Yla-gP2VK7Rtx46dpxUDA,1251
6
- cmd2/cmd2.py,sha256=DmRloJLh9VOQQLSI-PM-Ur2WNCh2okV07N13ULruGLE,247515
7
- cmd2/command_definition.py,sha256=c8PXb3r7uSgy72QxXHQ7G4d_K14pr3WiLu34zs7xTpA,6277
8
- cmd2/constants.py,sha256=O5SfjAZGgCl5-IxuHqBMmgbG3HhllxIcZBtkzzLYohA,1865
9
- cmd2/decorators.py,sha256=ixO16KcEY-qnpl8ollYdGIWQ56m5mOEBWR7AYJ252YU,19570
10
- cmd2/exceptions.py,sha256=Ae7zLnvs2oea2XYb0gnQ6QXng5x9fQJYl8r5wG0qCq8,3638
11
- cmd2/history.py,sha256=0XMPYru90JuZV8ea-pa9MBla5uL3XzDi5MPqZGaKiVE,14524
12
- cmd2/parsing.py,sha256=MON7fXRCzZ7BxQ1OTdKTFb6qcUdxhwXkcAUlzB1fUvQ,29028
13
- cmd2/plugin.py,sha256=Fi8gN6B6tuKHs8VXq1UTqB3yTKGMMYqTh4WkszBfx4Y,847
14
- cmd2/py.typed,sha256=qrkHrYJvGoZpU2BpVLNxJB44LlhqVSKyYOwD_L_1m3s,10
15
- cmd2/py_bridge.py,sha256=zf991EIAq5IPlWKc1HsONUKPOaDI4vpkYz5Xpk4MS58,4605
16
- cmd2/rl_utils.py,sha256=SscZBRBR4LjSvo9Av4c0CIIFJAs5KD0WFx5YifQ0CNc,10317
17
- cmd2/table_creator.py,sha256=U1c8lDXTU0YoXpOVQzzdFQ1-Zyk_aYBLY0vNSOaCoXo,47543
18
- cmd2/transcript.py,sha256=DSvFYWtKDf4Ee6XsGDf2UNTvr2kvMVQ1lVYjNq3LSus,9184
19
- cmd2/utils.py,sha256=JAxdVra8cDKPI8a_7-swB5kE7LltffsWX65a0AsxlQk,48054
20
- cmd2-2.4.3.dist-info/LICENSE,sha256=sHtj6A4XJ7RuSkgzXGvgjA8bPmqOdVnVJftwykRJbvI,1099
21
- cmd2-2.4.3.dist-info/METADATA,sha256=Vy4U2WkngOD1vZdj44WNyYUMGFcEIDZNNjKpH-QKPao,12041
22
- cmd2-2.4.3.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
23
- cmd2-2.4.3.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
24
- cmd2-2.4.3.dist-info/RECORD,,