Merge pull request #355 from tensorlayer/make

add a Makefile to help perform some common tasks

Author: lgarithm

.travis.yml

@@ -15,6 +15,7 @@ script:
   # - pytest
 
   # smoke tests
+  # - make test  # TODO: make it use python3 by default
   - python tests/test_yapf_format.py
   - python tests/test_pydocstyle.py
   - python tests/test_mnist_simple.py

CONTRIBUTING.md

@@ -10,4 +10,10 @@ The following tools are used to ensure that your commits can pass through the CI
 * [isort](https://github.com/timothycrosley/isort) (sort imports), optional
 * [autoflake](https://github.com/myint/autoflake) (remove unused imports), optional
 
-Please apply these tools in the changed files before submitting your PR.
+You can simply run
+
+```
+make format
+```
+
+to apply those tools before submitting your PR.

Makefile

@@ -0,0 +1,29 @@
+default:
+	@echo "Usage:"
+	@echo "\tmake lint      # run pylint"
+	@echo "\tmake format    # run yapf, autoflake and isort"
+	@echo "\tmake install3  # install tensorlayer in current workspace with pip3"
+
+lint:
+	pylint example/*.py
+	pylint tensorlayer
+
+test:
+	python tests/test_yapf_format.py
+	python tests/test_pydocstyle.py
+	python tests/test_mnist_simple.py
+
+format:
+	yapf -i example/*.py
+	yapf -i tensorlayer/*.py
+	yapf -i tensorlayer/**/*.py
+
+	autoflake -i example/*.py
+	autoflake -i tensorlayer/*.py
+	autoflake -i tensorlayer/**/*.py
+
+	isort -rc example
+	isort -rc tensorlayer
+
+install3:
+	pip3 install -U . --user