Add tasks.py to ease and standardize packaging

Author: kotfu

cmd2_submenu/pylintrc

@@ -0,0 +1,10 @@
+#
+# pylint configuration
+#
+#   $ pylint --rcfile=cmd2_submenu/pylintrc cmd2_submenu
+#
+
+[messages control]
+# too-few-public-methods          pylint expects a class to have at
+#                                 least two public methods
+disable=too-few-public-methods

setup.py

@@ -10,11 +10,9 @@
 with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
-VERSION='0.1.0'
-
 setuptools.setup(
     name='cmd2-submenu',
-    version=VERSION,
+    use_scm_version=True,
     description='A nested submenu system for cmd2',
     long_description=long_description,
     keywords='cmd2 plugin submenu',
@@ -27,7 +25,8 @@
     packages=['cmd2_submenu'],
 
     python_requires='>=3.4',
-    install_requires=['cmd2 >= 0.9.0, <=2'],
+    install_requires=['cmd2 >= 0.9.4, <=2'],
+    setup_requires=['setuptools_scm'],
 
     classifiers=[
         'Development Status :: 4 - Beta',
@@ -45,6 +44,6 @@
     # dependencies for development and testing
     # $ pip install -e .[dev]
     extras_require={
-        'dev': ['pytest']
+        'dev': ['setuptools_scm', 'pytest', 'invoke']
     },
 )

tasks.py

@@ -0,0 +1,160 @@
+#
+# -*- coding: utf-8 -*-
+"""Development related tasks to be run with 'invoke'"""
+
+import os
+import shutil
+
+import invoke
+
+# shared function
+def rmrf(items, verbose=True):
+    "Silently remove a list of directories or files"
+    if isinstance(items, str):
+        items = [items]
+
+    for item in items:
+        if verbose:
+            print("Removing {}".format(item))
+        shutil.rmtree(item, ignore_errors=True)
+        # rmtree doesn't remove bare files
+        try:
+            os.remove(item)
+        except FileNotFoundError:
+            pass
+
+
+# create namespaces
+namespace = invoke.Collection()
+namespace_clean = invoke.Collection('clean')
+namespace.add_collection(namespace_clean, 'clean')
+
+#####
+#
+# pytest, tox, pylint, and codecov
+#
+#####
+@invoke.task
+def pytest(context):
+    "Run tests and code coverage using pytest"
+    context.run("pytest --cov=cmd2_submenu")
+namespace.add_task(pytest)
+
+@invoke.task
+def pytest_clean(context):
+    "Remove pytest cache and code coverage files and directories"
+    #pylint: disable=unused-argument
+    dirs = ['.pytest_cache', '.cache', '.coverage']
+    rmrf(dirs)
+namespace_clean.add_task(pytest_clean, 'pytest')
+
+@invoke.task
+def tox(context):
+    "Run unit and integration tests on multiple python versions using tox"
+    context.run("tox")
+namespace.add_task(tox)
+
+@invoke.task
+def tox_clean(context):
+    "Remove tox virtualenvs and logs"
+    #pylint: disable=unused-argument
+    rmrf('.tox')
+namespace_clean.add_task(tox_clean, 'tox')
+
+@invoke.task
+def pylint(context):
+    "Check code quality using pylint"
+    context.run('pylint --rcfile=cmd2_submenu/pylintrc cmd2_submenu')
+namespace.add_task(pylint)
+
+@invoke.task
+def pylint_tests(context):
+    "Check code quality of test suite using pylint"
+    context.run('pylint --rcfile=tests/pylintrc tests')
+namespace.add_task(pylint_tests)
+
+
+#####
+#
+# build and distribute
+#
+#####
+BUILDDIR = 'build'
+DISTDIR = 'dist'
+
+@invoke.task
+def build_clean(context):
+    "Remove the build directory"
+    #pylint: disable=unused-argument
+    rmrf(BUILDDIR)
+namespace_clean.add_task(build_clean, 'build')
+
+@invoke.task
+def dist_clean(context):
+    "Remove the dist directory"
+    #pylint: disable=unused-argument
+    rmrf(DISTDIR)
+namespace_clean.add_task(dist_clean, 'dist')
+
+@invoke.task
+def eggs_clean(context):
+    "Remove egg directories"
+    #pylint: disable=unused-argument
+    dirs = set()
+    dirs.add('.eggs')
+    for name in os.listdir(os.curdir):
+        if name.endswith('.egg-info'):
+            dirs.add(name)
+        if name.endswith('.egg'):
+            dirs.add(name)
+    rmrf(dirs)
+namespace_clean.add_task(eggs_clean, 'eggs')
+
+@invoke.task
+def bytecode_clean(context):
+    "Remove __pycache__ directories and *.pyc files"
+    #pylint: disable=unused-argument
+    dirs = set()
+    for root, dirnames, files in os.walk(os.curdir):
+        if '__pycache__' in dirnames:
+            dirs.add(os.path.join(root, '__pycache__'))
+        for file in files:
+            if file.endswith(".pyc"):
+                dirs.add(os.path.join(root,file))
+    print("Removing __pycache__ directories and .pyc files")
+    rmrf(dirs, verbose=False)
+namespace_clean.add_task(bytecode_clean, 'bytecode')
+
+#
+# make a dummy clean task which runs all the tasks in the clean namespace
+clean_tasks = list(namespace_clean.tasks.values())
+@invoke.task(pre=list(namespace_clean.tasks.values()), default=True)
+def clean_all(context):
+    "Run all clean tasks"
+    #pylint: disable=unused-argument
+    pass
+namespace_clean.add_task(clean_all, 'all')
+
+@invoke.task(pre=[clean_all])
+def sdist(context):
+    "Create a source distribution"
+    context.run('python setup.py sdist')
+namespace.add_task(sdist)
+
+@invoke.task(pre=[clean_all])
+def wheel(context):
+    "Build a wheel distribution"
+    context.run('python setup.py bdist_wheel')
+namespace.add_task(wheel)
+
+@invoke.task(pre=[sdist, wheel])
+def pypi(context):
+    "Build and upload a distribution to pypi"
+    context.run('twine upload dist/*')
+namespace.add_task(pypi)
+
+@invoke.task(pre=[sdist, wheel])
+def pypi_test(context):
+    "Build and upload a distribution to https://test.pypi.org"
+    context.run('twine upload --repository-url https://test.pypi.org/legacy/ dist/*')
+namespace.add_task(pypi_test)

tests/pylintrc

@@ -0,0 +1,19 @@
+#
+# pylint configuration for tests package
+#
+#   $ pylint --rcfile=tests/pylintrc tests
+#
+
+[basic]
+# allow for longer method and function names
+method-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
+function-rgx=(([a-z][a-z0-9_]{2,50})|(_[a-z0-9_]*))$
+
+[messages control]
+# too-many-public-methods -> test classes can have lots of methods, so let's ignore those
+# missing-docstring -> prefer method names instead of docstrings
+# no-self-use -> test methods part of a class hardly ever use self
+# unused-variable -> sometimes we are expecting exceptions
+# redefined-outer-name -> pylint fixtures cause these
+# protected-access -> we want to test private methods
+disable=too-many-public-methods,missing-docstring,no-self-use,unused-variable,redefined-outer-name,protected-access