Add docs

CHANGES.rst

@@ -0,0 +1,6 @@
+Changes
+=======
+
+20180814 - 0.1.0
+----------------
+- Initial release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2018 Fabian Affolter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

README.rst

@@ -0,0 +1,70 @@
+python-volkszaehler
+===================
+
+Python API for interacting with `Volkszaehler <https://volkszaehler.org>`_. At
+the moment only the consumption of data is supported. Sorry, uploading is not
+possible.
+
+This module is not official, developed, supported or endorsed by Volkzaehler.
+
+Installation
+------------
+
+The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.
+
+.. code:: bash
+
+    $ pip3 install volkszaehler
+
+Usage
+-----
+
+The file ``example.py`` contains an example about how to use this module.
+
+Basically it's just a wrapper to get the JSON data from a given endpoint.
+
+.. code:: bash
+
+    $ curl http://demo.volkszaehler.org/middleware.php/data/57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json
+    {
+       "version":"0.3",
+       "data":{
+          "tuples":[
+             [
+                1521193871692,
+                0.18,
+                1
+             ]
+          ],
+          "uuid":"57acbef0-88a9-11e4-934f-6b0f9ecd95a8",
+          "from":1521193871682,
+          "to":1521193871692,
+          "min":[
+             1521193871692,
+             0.18
+          ],
+          "max":[
+             1521193871692,
+             0.18
+          ],
+          "average":0.18,
+          "consumption":0,
+          "rows":2
+       }
+    }
+
+Development
+-----------
+
+For development is recommended to use a ``venv``.
+
+.. code:: bash
+
+    $ python3.6 -m venv .
+    $ source bin/activate
+    $ python3 setup.py develop
+
+License
+-------
+
+``python-volkszaehler`` is licensed under MIT, for more details check LICENSE.