Merge remote-tracking branch 'origin/master' into client

Author: adamtheturtle

.coveragerc

@@ -0,0 +1 @@
+src/vws/_version.py export-subst

.gitattributes

@@ -0,0 +1,8 @@
+build:
+  image: latest
+
+python:
+   pip_install: true
+   version: 3.6
+   extra_requirements:
+       - dev

.isort.cfg

@@ -0,0 +1,10 @@
+Changelog
+=========
+
+.. contents::
+
+Next
+----
+
+2018.10.05.0
+------------

.pydocstyle

@@ -0,0 +1,2 @@
+include versioneer.py
+include src/vws/_version.py

.readthedocs.yml

@@ -1,8 +1,12 @@
 SHELL := /bin/bash -euxo pipefail
 
+# Treat Sphinx warnings as errors
+SPHINXOPTS := -W
+
 .PHONY: lint
 lint:
 	check-manifest .
+	doc8 .
 	dodgy
 	flake8 .
 	isort --recursive --check-only
@@ -13,14 +17,42 @@ lint:
 	pylint *.py src tests
 	pyroma --min 10 .
 	vulture . --min-confidence 100
-	yapf --diff --recursive src/ tests/
+	$(MAKE) -C docs spelling SPHINXOPTS=$(SPHINXOPTS)
+	$(MAKE) -C docs linkcheck SPHINXOPTS=$(SPHINXOPTS)
+	yapf \
+	    --diff \
+	    --recursive \
+	    --exclude versioneer.py \
+	    --exclude src/vws/_version.py \
+	    .
 
 .PHONY: fix-lint
 fix-lint:
 	# Move imports to a single line so that autoflake can handle them.
 	# See https://github.com/myint/autoflake/issues/8.
 	# Then later we put them back.
 	isort --force-single-line --recursive --apply
-	autoflake --in-place --recursive --remove-all-unused-imports --remove-unused-variables .
-	yapf --in-place --recursive .
+	autoflake \
+	    --in-place \
+	    --recursive \
+	    --remove-all-unused-imports \
+	    --remove-unused-variables \
+	    --exclude src/vws/_version.py,versioneer.py \
+	    .
+	yapf \
+	    --in-place \
+	    --recursive \
+	    --exclude versioneer.py  \
+	    --exclude src/vws/_version.py \
+	    .
 	isort --recursive --apply
+
+.PHONY: docs
+docs:
+	make -C docs clean html SPHINXOPTS=$(SPHINXOPTS)
+
+.PHONY: open-docs
+open-docs:
+	xdg-open docs/build/html/index.html >/dev/null 2>&1 || \
+	open docs/build/html/index.html >/dev/null 2>&1 || \
+	echo "Requires 'xdg-open' or 'open' but neither is available."

.style.yapf

@@ -1,33 +1,33 @@
-|Build Status| |codecov| |Updates|
+|Build Status| |codecov| |Updates| |PyPI| |Documentation Status|
 
 vws-python
 ==========
 
 Python library for the Vuforia Web Services (VWS) API and the Vuforia Web Query API.
 
-Contributing
-------------
-
-See `CONTRIBUTING.rst <./CONTRIBUTING.rst>`_ for details on how to contribute to this project.
-
 Installation
 ------------
 
-This package has not yet been uploaded to PyPI.
-
-For now it is possible to install the work in progress:
-
 .. code:: sh
 
-    pip install git+https://github.com/adamtheturtle/vws-python@master
+   pip install vws-python
 
-This requires Python 3.6+.
+This is tested on Python 3.7+.
 Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
 
+Full Documentation
+------------------
+
+See the `full documentation <https://vws-python.readthedocs.io/en/latest>`__.
 
 .. |Build Status| image:: https://travis-ci.org/adamtheturtle/vws-python.svg?branch=master
    :target: https://travis-ci.org/adamtheturtle/vws-python
 .. |codecov| image:: https://codecov.io/gh/adamtheturtle/vws-python/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/adamtheturtle/vws-python
 .. |Updates| image:: https://pyup.io/repos/github/adamtheturtle/vws-python/shield.svg
    :target: https://pyup.io/repos/github/adamtheturtle/vws-python/
+.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python/badge/?version=latest
+   :target: https://vws-python.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation Status
+.. |PyPI| image:: https://badge.fury.io/py/VWS-Python.svg
+   :target: https://badge.fury.io/py/VWS-Python