feat: Added Makefile (appium#530)

* Created setup.cfg

* Updated lib ver for pre-commit

* Fix ci.sh to set failure even when one command failed

* Fix pylint error

* Add help to Makefile

* Update README

* Add check-all command

Author: ki4070ma

.config-pep8

@@ -1,15 +1,15 @@
 -   repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.4
+    rev: v1.5.2
     hooks:
     -   id: autopep8
-        args: ["-a", "--global-config", ".config-pep8", "-i"]
+        args: ["-a", "-i"]
 -   repo: https://github.com/pre-commit/mirrors-isort
-    rev: v4.3.20
+    rev: v4.3.21
     hooks:
     -   id: isort
         args: ["-rc", "."]
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v0.761'
+    rev: 'v0.770'
     hooks:
     -   id: mypy
         entry: mypy appium/ test/

.isort.cfg

@@ -0,0 +1,30 @@
+.PHONY: Commands for developers
+
+.PHONY: check-all
+check-all: ## Run all lint checks and unittest
+	@echo "[Notice] If you'd like to run commands with same env to CI, please run \`tox\`."
+	@bash ci.sh
+
+.PHONY: isort
+isort: ## Run isort
+	python -m isort $(ARGS) -rc .
+
+.PHONY: autopep8
+autopep8: ## Run autopep8
+	python -m autopep8 $(ARGS) -a -r -i .
+
+.PHONY: pylint
+pylint: ## Run pylint
+	python -m pylint $(ARGS) --rcfile .pylintrc appium test
+
+.PHONY: mypy
+mypy:  ## Run mypy
+	python -m mypy appium test
+
+.PHONY: unittest
+unittest: ## Run unittest
+	python -m pytest test/unit/
+
+.PHONY: help
+help: ## Display this help screen
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

.pre-commit-config.yaml

@@ -135,6 +135,7 @@ https://appium.github.io/python-client-sphinx/ is detailed documentation
 
 - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
   - Apply `autopep8`, `isort` and `mypy` as pre commit hook
+  - Run `make` command for development. See `make help` output for details
 - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 - `gitchangelog` generates `CHANGELOG.rst`
 

Makefile

@@ -60,7 +60,7 @@ def events(self) -> Dict:
             session = self.session
             return session['events']
         except Exception as e:
-            logger.warning('Could not find events information in the session. Error:', e)
+            logger.warning('Could not find events information in the session. Error: %s', e)
             return {}
 
     # pylint: disable=protected-access

README.md

@@ -1,43 +1,27 @@
 #!/bin/bash
 
-set -o pipefail
-
 EXIT_STATUS=0
-if ! python -m autopep8 --exit-code -a -r --global-config .config-pep8 -i . ; then
-  echo "Please run command 'python -m autopep8 -a -r --global-config .config-pep8 -i .' on your local and commit the result"
+
+if ! make autopep8 ARGS=--exit-code ; then
+  echo "Please run command 'make autopep8' on your local and commit the result"
   EXIT_STATUS=1
 fi
 
-if ! python -m isort --check-only -rc . ; then
-  echo "Please run command 'python -m isort -rc .' on your local and commit the result"
+if ! make isort ARGS=--check-only ; then
+  echo "Please run command 'make isort' on your local and commit the result"
   EXIT_STATUS=1
 fi
 
-(
-  LINT_RESULT=$(python -m pylint --rcfile .pylintrc appium test --errors-only 2>&1 | tee /dev/tty)
-  if [[ $? -ne 0 ]] ; then
-    EXIT_STATUS=1
-  fi
-
-  # FIXME: pylint x Python 3.7 cause this runtime error.
-  # We must remove here when we drop Python 2 (and can update pylint) or
-  # install newer pylint for Python 3.7 environment on CI
-  if [[ $LINT_RESULT =~ "RuntimeError: generator raised StopIteration" ]] ; then
-    EXIT_STATUS=0
-  fi
-)
+if ! make pylint ARGS=--errors-only ; then
+  echo "Please run command 'make pylint' on your local and fix errors"
+  EXIT_STATUS=1
+fi
 
-(
-  python -m pytest test/unit/
-)
-if [[ $? -ne 0 ]] ; then
+if ! make unittest ; then
   EXIT_STATUS=1
 fi
 
-(
-  python -m mypy appium test
-)
-if [[ $? -ne 0 ]] ; then
+if ! make mypy ; then
   EXIT_STATUS=1
 fi
 

appium/webdriver/extensions/session.py

@@ -1 +1,2 @@
-sphinx >= 3.0, <4.0
+sphinx >= 3.0, <4.0
+sphinx_rtd_theme < 1.0

ci.sh

@@ -1,3 +1,11 @@
+[pep8]
+max-line-length = 120
+
+[isort]
+multi_line_output = 3
+known_third_party = dateutil,httpretty,pytest,selenium,setuptools,urllib3,mock,sauceclient
+known_first_party = test,appium
+
 [mypy]
 check_untyped_defs = True
 disallow_untyped_calls = True