Merge branch 'master' into pep8radius

Author: jacebrowning

.scrutinizer.yml

@@ -4,3 +4,6 @@ checks:
         duplicate_code: true
 tools:
     external_code_coverage: true
+    pylint:
+        python_version: 3
+        config_file: '.pylintrc'

.travis.yml

@@ -1,5 +1,6 @@
 language: python
 python:
+- 2.7
 - 3.3
 - 3.4
 env:

Makefile

@@ -1,6 +1,8 @@
 # Python settings
-PYTHON_MAJOR := 3
-PYTHON_MINOR := 4
+ifndef TRAVIS
+	PYTHON_MAJOR := 3
+	PYTHON_MINOR := 4
+endif
 
 # Test runner settings
 ifndef TEST_RUNNER
@@ -56,6 +58,10 @@ NOSE := $(BIN)/nosetests
 PYTEST := $(BIN)/py.test
 COVERAGE := $(BIN)/coverage
 
+# Remove if you don't want pip to cache downloads
+PIP_CACHE_DIR := .cache
+PIP_CACHE := --download-cache $(PIP_CACHE_DIR)
+
 # Flags for PHONY targets
 DEPENDS_CI := $(ENV)/.depends-ci
 DEPENDS_DEV := $(ENV)/.depends-dev
@@ -91,13 +97,13 @@ depends: .depends-ci .depends-dev
 .PHONY: .depends-ci
 .depends-ci: env Makefile $(DEPENDS_CI)
 $(DEPENDS_CI): Makefile
-	$(PIP) install --upgrade pep8 pep257 $(TEST_RUNNER) coverage
+	$(PIP) install $(PIP_CACHE) --upgrade pep8 pep257 $(TEST_RUNNER) coverage
 	touch $(DEPENDS_CI)  # flag to indicate dependencies are installed
 
 .PHONY: .depends-dev
 .depends-dev: env Makefile $(DEPENDS_DEV)
 $(DEPENDS_DEV): Makefile
-	$(PIP) install --upgrade pep8radius docutils pdoc pylint wheel
+	$(PIP) install $(PIP_CACHE) --upgrade pep8radius pygments docutils pdoc pylint wheel
 	touch $(DEPENDS_DEV)  # flag to indicate dependencies are installed
 
 # Documentation ##############################################################
@@ -190,13 +196,13 @@ tests-pytest: .depends-ci
 clean: .clean-dist .clean-test .clean-doc .clean-build
 	rm -rf $(ALL)
 
-.PHONY: clean-all
-clean-all: clean .clean-env
-
-.PHONY: .clean-env
-.clean-env:
+.PHONY: clean-env
+clean-env: clean
 	rm -rf $(ENV)
 
+.PHONY: clean-all
+clean-all: clean clean-env .clean-workspace .clean-cache
+
 .PHONY: .clean-build
 .clean-build:
 	find . -name '*.pyc' -delete
@@ -215,6 +221,14 @@ clean-all: clean .clean-env
 .clean-dist:
 	rm -rf dist build
 
+.PHONY: .clean-cache
+.clean-cache:
+	rm -rf $(PIP_CACHE_DIR)
+
+.PHONY: .clean-workspace
+.clean-workspace:
+	rm -rf *.sublime-workspace
+
 # Release ####################################################################
 
 .PHONY: .git-no-changes

README.md

@@ -7,56 +7,64 @@ Foobar
 [![PyPI Version](http://img.shields.io/pypi/v/foobar.svg)](https://pypi.python.org/pypi/foobar)
 [![PyPI Downloads](http://img.shields.io/pypi/dm/foobar.svg)](https://pypi.python.org/pypi/foobar)
 
-Foobar is a template for a typical Python 3 library package.
+This is a template for a typical Python library following modern packaging conventions. It utilizes popular Python libraries, external tools, and web services to fully automate all development and deployment tasks. 
 
-To adopt for a new project:
+Here are few sample projects to see this template in action:
 
-* replace `foobar` and `template-python` with your package name
-* replace `Foobar` with your project name (might be the same as the package)
-* set `TEST_RUNNER` in the `Makefile` to your preferred test runner (`nose` or `pytest`)
-* remove the `TEST_RUNNER` environment lines in `.travis.yml`
-* update the links to point to your code repository and badges
-* change the license
+* [jacebrowning/doorstop](https://github.com/jacebrowning/doorstop)
+* [MichiganLabs/flask-gcm](https://github.com/MichiganLabs/flask-gcm)
+* [theovoss/BoggleSolver](https://github.com/theovoss/BoggleSolver)
 
+To adopt for your next project:
 
+* download this repository's [source code](https://github.com/jacebrowning/template-python/archive/master.zip) to a new directory
+* set `PYTHON_MAJOR` and `PYTHON_MINOR` in the `Makefile` to your default Python version
+* set `TEST_RUNNER` in the `Makefile` to your preferred test runner (`nose` or `pytest`)
+* remove the `TEST_RUNNER` [environment lines](https://github.com/jacebrowning/template-python/blob/850cdcbcfec99d9d844482761ed5492274720687/.travis.yml#L6-8) in `.travis.yml`
+* replace all instances of `foobar` and `template-python` with your package name
+* replace all instances of `Foobar` with your project name (might be the same as the package)
+* update all links to point to your code repository and badges
+* change the license
+* replace all the above text with your project's description
 
 Getting Started
 ===============
 
 Requirements
 ------------
 
-* Python 3.3+
-
+* Python 2.7+ or Python 3.3+
 
 Installation
 ------------
 
-Foobar can be installed with 'pip':
+Foobar can be installed with pip:
 
-    $ pip install Foobar
-
-Or directly from the source code:
-
-    $ git clone https://github.com/jacebrowning/template-python.git
-    $ cd template-python
-    $ python setup.py install
+```shell
+$ pip install Foobar
+```
 
+or directly from the source code:
 
+```shell
+$ git clone https://github.com/jacebrowning/template-python.git
+$ cd template-python
+$ python setup.py install
+```
 
 Basic Usage
 ===========
 
 After installation, abstract base classes can be imported from the package:
 
-    $ python
-    >>> import foobar
-    foobar.__version__
+```shell
+$ python
+>>> import foobar
+foobar.__version__
+```
 
 Foobar doesn't do anything, it's a template.
 
-
-
 For Contributors
 ================
 
@@ -71,31 +79,40 @@ Requirements
 * Pandoc: http://johnmacfarlane.net/pandoc/installing.html
 * Graphviz: http://www.graphviz.org/Download.php
 
-
 Installation
 ------------
 
 Create a virtualenv:
 
-    $ make env
+```shell
+$ make env
+```
 
 Run the tests:
 
-    $ make test
-    $ make tests  # includes integration tests
+```shell
+$ make test
+$ make tests  # includes integration tests
+```
 
 Build the documentation:
 
-    $ make doc
+```shell
+$ make doc
+```
 
 Run static analysis:
 
-    $ make pep8
-    $ make pep257
-    $ make pylint
-    $ make check  # includes all checks
+```shell
+$ make pep8
+$ make pep257
+$ make pylint
+$ make check  # includes all checks
+```
 
 Prepare a release:
 
-    $ make dist  # dry run
-    $ make upload
+```shell
+$ make dist  # dry run
+$ make upload
+```