Merge pull request #53 from timgates42/feature/upstream_update

Update with latest upstream changes

app/MANIFEST.in

@@ -3,5 +3,6 @@ include README.md
 include short_description.txt
 include requirements.txt
 
+
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

app/pip/2.7/test/requirements.txt

@@ -11,3 +11,4 @@ pytest-xdist
 safety
 twine
 wheel
+

app/pip/3.4/test/requirements.txt

@@ -11,3 +11,4 @@ pytest-xdist
 safety
 twine
 wheel
+

app/pip/3.5/test/requirements.txt

@@ -11,3 +11,4 @@ pytest-xdist
 safety
 twine
 wheel
+

app/pip/3.6/test/requirements.txt

@@ -11,3 +11,4 @@ pytest-xdist
 safety
 twine
 wheel
+

app/pip/3.7/spelling/requirements.txt

@@ -1,2 +1,3 @@
 pyspelling
-resplendent
+wcmatch<5.0
+resplendent==0.2.3

app/pip/3.7/test/requirements.txt

@@ -11,3 +11,4 @@ pytest-xdist
 safety
 twine
 wheel
+

app/setup.py

@@ -58,10 +58,19 @@ def read_version():
     maintainer_email="email@goes.here",
     packages=find_packages(exclude=["tests"]),
     license="GPLv3+",
-    description=load_include("short_description.txt"),
+    description=load_include("short_description.txt")
+    .replace("\n", " ")
+    .replace("\r", "")
+    .strip(),
     long_description=load_include("README.md", transform=True),
     long_description_content_type="text/markdown",
     python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
+    test_suite="tests",
+    test_requires=[
+        elem.strip()
+        for elem in load_include("test_requires.txt").splitlines()
+        if elem.strip()
+    ],
     install_requires=[
         elem.strip()
         for elem in load_include("requirements.txt").splitlines()

app/test_requires.txt

@@ -0,0 +1,3 @@
+mock
+pytest
+

app/tests/test_main.py

@@ -4,15 +4,15 @@
 module_goes_here.__main__
 """
 
+from module_goes_here.__main__ import main
+
 
 def test_main():
     """
     GIVEN the .__main__ module entry point WHEN calling main THEN the call
     executes successfully with a result of `None`
     """
     # Setup
-    from module_goes_here.__main__ import main
-
     # Exercise
     result = main()  # pylint: disable=assignment-from-no-return
     # Verify

ci.sh

@@ -4,19 +4,5 @@ set -euxo pipefail
 
 BASEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
-CMD="${1:-test}"
-if ! which docker ; then
-    echo 'Docker is missing!' >&2
-    exit 1
-fi
-if ! which docker-compose ; then
-    echo 'Docker-Compose is missing!' >&2
-    exit 1
-fi
-if [[ "$CMD" =~ [^a-zA-Z0-9_] ]]; then
-    echo "Invalid Command: ${CMD}" >&2
-    exit 1
-fi
-cd "${BASEDIR}"
-"${BASEDIR}/ci/${CMD}.sh" "${@:2}"
+"${BASEDIR}/ci/task.sh" "${@}"
 

ci/in_docker/publish.sh

@@ -13,5 +13,6 @@ rm -rf dist build
 for PYVER in ${PYTHONVERS} ; do
   "python${PYVER}" setup.py sdist bdist_wheel
 done
+python3.7 -m twine check dist/*
 python3.7 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 python3.7 -m twine upload dist/*

ci/in_docker/test.sh

@@ -15,12 +15,12 @@ PYVER=3.7
 # Run pyspelling in root to check docs
 "python${PYVER}" -m pyspelling
 # Run black to check all python on 3.7 only
-"python${PYVER}" -m black --check "${BASEDIR}"
+"python${PYVER}" -m black --check --diff "${BASEDIR}"
 cd "${BASEDIR}/app"
 # Version dependant checks
 for PYVER in ${PYTHONVERS} ; do
   "python${PYVER}" -m flake8 "${MODULES[@]}"
-  "python${PYVER}" -m isort -rc -c --diff "${MODULES[@]}"
+  "python${PYVER}" -m isort -rc -c -m 3 --diff "${MODULES[@]}"
   "python${PYVER}" -m bandit -r "${MODULES[@]}"
   find "${MODULES[@]}" -iname \*.py -print0 | xargs -0 -n 1 "${BASEDIR}/ci/in_docker/pylint.sh" "python${PYVER}"
   PYTEST_FAIL="NO"

ci/task.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+THISDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+BASEDIR="$( dirname "${THISDIR}" )"
+
+if ! which docker ; then
+    echo 'Docker is missing!' >&2
+    exit 1
+fi
+if ! which docker-compose ; then
+    echo 'Docker-Compose is missing!' >&2
+    exit 1
+fi
+cd "${BASEDIR}"
+
+CMD="${1:-test}"
+if [[ "$CMD" =~ [^a-zA-Z0-9_] ]]; then
+    echo "Invalid Command: ${CMD}" >&2
+    exit 1
+fi
+TASK="ci/in_docker/${CMD}.sh"
+OUT_DOCKER="${BASEDIR}/${TASK}"
+IN_DOCKER="/workspace/${TASK}"
+if [ ! -f "${OUT_DOCKER}" ] ; then
+    echo "No command: ${OUT_DOCKER}" >&2
+    exit 1
+fi
+if [ ! -x "${OUT_DOCKER}" ] ; then
+    echo "Not executable: ${OUT_DOCKER}" >&2
+    exit 1
+fi
+
+# shellcheck source=/dev/null
+source "${BASEDIR}/ci/shared/_docker_helper.sh"
+
+docker_compose_run "app" "${IN_DOCKER}" "${@:2}"
+
+

cookiecutter.json

@@ -43,5 +43,8 @@
         "GPLv3+",
         "MIT"
     ],
-    "entry_points": ""
+    "entry_points": "",
+    "package_data": "",
+    "extra_manifest": "",
+    "test_requires": ""
 }

docs/spelling_wordlist.txt

@@ -53,6 +53,7 @@ Json
 junit
 JUnit
 li
+logdecorator
 lt
 lxml
 maxdepth
@@ -123,6 +124,7 @@ unicode
 unmaintained
 urls
 utf
+wcmatch
 webgui
 xdist
 xml