Metadata-Version: 2.1
Name: cmd2-submenu
Version: 0.3.0
Summary: A nested submenu system for cmd2
Home-page: https://github.com/python-cmd2/cmd2-submenu
Author: python-cmd2
Author-email: 
License: MIT
Keywords: cmd2 plugin submenu
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.4
Provides-Extra: dev
Requires-Dist: cmd2 (<=2,>=0.9.6)
Provides-Extra: dev
Requires-Dist: setuptools-scm; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: invoke; extra == 'dev'

# cmd2-submenu
This project provides a submenu system for cmd2

## Installing
To install the plugin, do:
```
$ pip install cmd2-submenu
```

## How to use

## Running tests

`cmd2` uses a three tiered testing strategy to test on multiple versions
of python on various platforms. This plugin uses the same strategy:

- [pytest](https://pytest.org) runs the unit tests
- [tox](https://tox.readthedocs.io/) runs the unit tests on multiple versions
  of python
- [AppVeyor](https://www.appveyor.com/) and [TravisCI](https://travis-ci.com)
  run the tests on the various supported platforms

### Running unit tests

Run `pytest` from the top level directory of this plugin to run all the
unit tests.

### Use tox to run unit tests in multiple versions of python

The included `tox.ini` is setup to run the unit tests in python 3.4, 3.5,
and 3.6. In order for `tox` to work, you need to have different versions of
python executables available in your path.
[pyenv](https://github.com/pyenv/pyenv) is one method of doing this easily.
Once `pyenv` is installed, use it to install multiple versions of python:

```
$ pyenv install 3.4.8
$ pyenv install 3.5.5
$ pyenv install 3.6.5
$ pyenv local 3.6.5 3.5.5 3.4.8
```

This will create a `.python-version` file and instruct the `pyenv` shims
to make `python3.6`, `python3.5`, and `python3.4` launch the appropriate
versions of python.

Once these executables are configured, invoking `tox` will create a
virtual environment for each version of python, install the prerequisite
packages, and run your unit tests.



