Add testing

Author: porowns

.coveragerc.example

@@ -0,0 +1,23 @@
+[run]
+branch = True
+source =
+    django_package_template
+
+omit =
+    */django_package_template/migrations/*
+    */tests/*
+    */.tox/*
+    */bin/*
+    */test/*
+    runtests.py
+
+[report]
+exclude_lines =
+    if self.debug:
+    pragma: no cover
+    raise NotImplementedError
+    if __name__ == .__main__.:
+    def __repr__
+    raise AssertionError
+
+ignore_errors = True

.travis.yml.example

@@ -1,29 +1,14 @@
-dist: xenial
 language: python
-
-python:
-- "3.6"
-
-services:
-  - docker 
-
-before_install:
-- export DJANGO_SETTINGS_MODULE=app.settings
-- export EXTENSIONS=unknown_app
-
+sudo: false
+cache: pip
+dist: xenial
 install:
-- pip install -e django_package_template
-- django-admin startproject app 
-- cp conf/settings.py app/app/settings.py
-- pip3 install coverage python-coveralls sphinx-markdown-tables django-extensions ipython notebook
-- cd app/
-- python3 manage.py migrate
-- cd ../
-
-
-jobs:
+  - pip install coveralls>=1.1 tox
+script:
+  - tox
+after_success:
+  coveralls
+matrix:
   include:
-    - stage: test
-      script:
-        - cd app/
-        - coverage run --omit=**/tests.py,./install/*,./launcher,**/wsgi.py,**/manage.py --source=. ./manage.py test django_package_template --noinput --settings=app.settings
+   - env: TOXENV=py36
+     python: '3.6.7'

MANIFEST.in renamed to MANIFEST.in.example

@@ -10,7 +10,10 @@
 example_files = [
     '.travis.yml',
     'setup.py',
-    'mkdocs.yml'
+    'mkdocs.yml',
+    'tox.ini',
+    'MANIFEST.in',
+    '.coveragerc'
 ]
 
 get_package_name = subprocess.run(
@@ -51,11 +54,30 @@ def commands_succeeded(rcs):
 
 @manager.command
 def echo():
+    """Echo package directory."""
     print(dir_path)
 
 
+@manager.command
+def deploy():
+    """Deploy package and docs. Type in username and password for PyPi."""
+    commands = [
+        "python3 setup.py sdist",
+        "python3 -m twine upload dist/*",
+        "python3 -m mkdocs gh-deploy"
+    ]
+    command_rcs = set()
+    for command in commands:
+        print(command)
+        command_rcs.add(subprocess.run(
+            [command],
+            stdout=subprocess.PIPE,
+            shell=True).returncode)
+
+
 @manager.command
 def venv():
+    """Create a virtual environment."""
     command_rc = subprocess.run(
         [f"python3 -m venv {dir_path}/venv"],
         stdout=subprocess.PIPE,
@@ -66,8 +88,9 @@ def venv():
         exit()
 
 
-@manager.command
-def initialize():
+@ manager.command
+def init():
+    """Initialize the project."""
     # Create application
     create_project = subprocess.run(
         [f"django-admin startapp {app_name}"],
@@ -125,8 +148,26 @@ def initialize():
     print("Successfully initialized project")
 
 
-@manager.command
-def scorched_earth():
+@ manager.command 
+def prune():
+    """Prune all .example files. WARNING: Init will no longer function."""
+    for example_files in example_files:
+        command_rcs = set()
+        command = f'rm -rf {dir_path}/{example_file}.example'
+        print(command)
+
+        command_rcs.add(subprocess.run(
+            [command],
+            stdout=subprocess.PIPE,
+            shell=True
+        ).returncode)
+        if not commands_succeeded(command_rcs):
+            print("Failed to clear files")
+            exit()
+
+@ manager.command
+def purge():
+    """Purge all created files."""
     for example_file in example_files:
         command_rcs = set()
         command = f'rm -rf {dir_path}/{example_file}'
@@ -152,16 +193,29 @@ def scorched_earth():
         print("Failed to clear files")
         exit()
 
-    command = f'rm -rf {dir_path}/venv'
-    print(command)
-    command_rcs.add(subprocess.run(
-        [command],
-        stdout=subprocess.PIPE,
-        shell=True
-    ).returncode)
-    if not commands_succeeded(command_rcs):
-        print("Failed to clear files")
-        exit()
+    extra_files = [
+        'coverage.xml',
+        'dist',
+        '.coverage',
+        '*.egg-info',
+        'site',
+        '.tox',
+        'venv'
+    ]
+    
+    for example_file in extra_files:
+        command_rcs = set()
+        command = f'rm -rf {dir_path}/{example_file}'
+        print(command)
+
+        command_rcs.add(subprocess.run(
+            [command],
+            stdout=subprocess.PIPE,
+            shell=True
+        ).returncode)
+        if not commands_succeeded(command_rcs):
+            print("Failed to clear files")
+            exit()
 
 
 if __name__ == '__main__':

manage.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'test.app.settings'
+    print(os.getcwd())
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError:
+        try:
+            import django
+        except ImportError:
+            raise ImportError(
+                "Couldn't import Django. Are you sure it's installed and "
+                "available on your PYTHONPATH environment variable? Did you "
+                "forget to activate a virtual environment?"
+            )
+        raise
+    execute_from_command_line(sys.argv.insert(1, 'test'))

runtests.py

@@ -1,6 +1,10 @@
 import os
 from setuptools import find_packages, setup
 
+install_requires = [
+    'Django'
+]
+
 with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
     README = readme.read()
 
@@ -32,6 +36,5 @@ setup(
         'Topic :: Internet :: WWW/HTTP',
         'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
     ],
-    install_requires=[
-    ]
+    install_requires=install_requires
 )

setup.py.example

@@ -0,0 +1,16 @@
+[tox]
+envlist = py36
+[testenv]
+setenv = 
+    DJANGO_SETTINGS_MODULE = tests.app.settings
+
+deps=
+    Django
+    coverage
+    .[test]
+
+commands =
+    pip freeze
+    coverage run runtests.py
+    coverage report -m
+    coverage xml