Brought in cmd2 plugin template as a first-class member of cmd2 proper

Author: anselor

noxfile.py

@@ -12,15 +12,16 @@ def docs(session):
 
 
 @nox.session(python=['3.5', '3.6', '3.7', '3.8', '3.9'])
-def tests(session):
-    session.install('invoke', './[test]')
-    session.run('invoke', 'pytest', '--junit', '--no-pty')
+@nox.parametrize('plugin', [None, 'ext_test', 'template'])
+def tests(session, plugin):
+    if plugin is None:
+        session.install('invoke', './[test]')
+        session.run('invoke', 'pytest', '--junit', '--no-pty')
+    else:
+        session.install('invoke', '.')
 
-    # cd into test directory to run other unit test
-    session.chdir('./plugins/ext_test')
-    session.install('.[test]')
-    session.run('invoke', 'pytest', '--junit', '--no-pty', '--append-cov')
+        # cd into test directory to run other unit test
+        session.install('plugins/{}[test]'.format(plugin))
+        session.run('invoke', 'plugin.{}.pytest'.format(plugin.replace('_', '-')), '--junit', '--no-pty')
 
-    # return to top directory to submit coverage
-    session.chdir('../..')
     session.run('codecov')

plugins/README.txt

@@ -0,0 +1 @@
+For information about creating a cmd2 plugin, see template/README.md

plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py

@@ -2,12 +2,17 @@
 # coding=utf-8
 """External test interface plugin"""
 
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 import cmd2
 
+if TYPE_CHECKING:
+    _Base = cmd2.Cmd
+else:
+    _Base = object
 
-class ExternalTestMixin:
+
+class ExternalTestMixin(_Base):
     """A cmd2 plugin (mixin class) that exposes an interface to execute application commands from python"""
 
     def __init__(self, *args, **kwargs):

plugins/tasks.py

@@ -9,16 +9,13 @@
     - setuptools >= 39.1.0
 """
 import os
-import re
-import shutil
-import sys
-
 import invoke
 
 from plugins.ext_test import tasks as ext_test_tasks
+from plugins.template import tasks as template_tasks
 
 # create namespaces
-namespace = invoke.Collection()
+namespace = invoke.Collection(ext_test=ext_test_tasks, template=template_tasks)
 namespace_clean = invoke.Collection('clean')
 namespace.add_collection(namespace_clean, 'clean')
 

plugins/template/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 1.0.0 (2018-07-24)
+
+### Added
+- Created plugin template and initial documentation
+
+

plugins/template/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jared Crapo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.