tasks.py

# -*- coding: utf-8 -*-
import os
import sys
import webbrowser

from invoke import task, run

docs_dir = 'docs'
build_dir = os.path.join(docs_dir, '_build')

@task
def test(coverage=False, browse=False):
    flake()
    import pytest
    args = []
    if coverage:
        args.extend(['--cov=webargs', '--cov-report=term', '--cov-report=html'])

    if sys.version_info < (3, 4, 1):
        args.append('--ignore={0}'.format(os.path.join('tests', 'test_aiohttp')))
    retcode = pytest.main(args)
    if coverage and browse:
        webbrowser.open_new_tab(os.path.join('htmlcov', 'index.html'))
    sys.exit(retcode)

@task
def flake():
    """Run flake8 on codebase."""
    cmd = 'flake8 .'
    if sys.version_info < (3, 4, 1):
        excludes = [
            os.path.join('tests', 'test_aiohttp'),
            os.path.join('webargs', 'async.py'),
            os.path.join('webargs', 'aiohttpparser.py'),
            os.path.join('examples', 'annotations_example.py'),
            'build',
        ]
        cmd += ' --exclude={0}'.format(','.join(excludes))
    run(cmd, echo=True)

@task
def clean():
    run("rm -rf build")
    run("rm -rf dist")
    run("rm -rf webargs.egg-info")
    clean_docs()
    print("Cleaned up.")

@task
def readme(browse=False):
    run('rst2html.py README.rst > README.html')
    if browse:
        webbrowser.open_new_tab('README.html')

@task
def clean_docs():
    run("rm -rf %s" % build_dir)

@task
def browse_docs():
    path = os.path.join(build_dir, 'index.html')
    webbrowser.open_new_tab(path)

@task
def docs(clean=False, browse=False, watch=False):
    """Build the docs."""
    if clean:
        clean_docs()
    run("sphinx-build %s %s" % (docs_dir, build_dir), echo=True)
    if browse:
        browse_docs()
    if watch:
        watch_docs()

@task
def watch_docs():
    """Run build the docs when a file changes."""
    try:
        import sphinx_autobuild  # noqa
    except ImportError:
        print('ERROR: watch task requires the sphinx_autobuild package.')
        print('Install it with:')
        print('    pip install sphinx-autobuild')
        sys.exit(1)
    run('sphinx-autobuild {0} {1} --watch {2}'.format(
        docs_dir, build_dir, 'webargs'), echo=True, pty=True)

@task
def publish(test=False):
    """Publish to the cheeseshop."""
    clean()
    if test:
        run('python setup.py register -r test sdist bdist_wheel', echo=True)
        run('twine upload dist/* -r test', echo=True)
    else:
        run('python setup.py register sdist bdist_wheel', echo=True)
        run('twine upload dist/*', echo=True)