Add yapf, flake8, mypy

Author: lossyrob

.travis.yml

@@ -11,6 +11,11 @@ install:
   - pip install -r requirements-dev.txt
 
 script:
+  - flake8 pystac
+  - flake8 tests
+  - yapf -dpr pystac
+  - yapf -dpr tests
+  - mypy -m pystac
   - python -m unittest discover tests/
 
 deploy:

README.md

@@ -49,12 +49,52 @@ To ensure development libraries are installed, install everything in `requiremen
 > pip install -r requirements-dev.txt
 ```
 
+### Unit Tests
+
 Unit tests are in the `tests` folder. To run unit tests, use `unittest`:
 
 ```
 > python -m unittest discover tests
 ```
 
+### Code quality checks
+
+PySTAC uses [flake8](), [yapf](), and [mypy]() for code formatting and type checking.
+
+To run the style checks:
+
+```
+> flake8 pystac
+> flake8 tests
+```
+
+To format code:
+
+```
+> yapf -ipr pystac
+> yapf -ipr tests
+```
+
+To run the mypy static checker:
+
+```
+> mypy -m pystac
+```
+
+### Documentation
+
+To build and develop the documentation locally, make sure sphinx is available (which is installed with `requirementts-dev.txt`), and use the Makefile in the docs folder:
+
+```
+> cd docs
+> make html
+> make livehtml
+```
+
+Use 'make' without arguments to see a list of available commands.
+
+
+
 ## Running the tutorials
 
 There are tutorials written as jupyter notebooks in the `tutorials` folder. To run them, run a jupyter notebook with the `tutorials` directory as the notebook directory:

requirements-dev.txt

@@ -3,3 +3,7 @@ pylint==1.9.1
 Sphinx==1.8.0
 sphinx-autobuild==0.7.1
 sphinxcontrib-fulltoc==1.2.0
+sphinxcontrib-napoleon==0.7
+mypy==0.740
+flake8==3.7.*
+yapf==0.28.*