Initial commit

Author: fabaff

.gitignore

@@ -0,0 +1,101 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 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,31 @@
+python-luftdaten
+================
+
+Python API for interacting with `luftdaten.info <http://luftdaten.info/>`_.
+
+Installation
+------------
+The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.
+
+.. code:: bash
+
+    $ pip3 install luftdaten
+
+Usage
+-----
+
+The file ``example.py`` contains an example about how to use this module.
+
+Development
+-----------
+For development is recommended to use a ``venv``.
+
+.. code:: bash
+
+    $ python3.6 -m venv .
+    $ source bin/activate
+    $ python3 setup.py develop
+
+License
+-------
+``python-luftdaten`` is licensed under MIT, for more details check LICENSE.

example.py

@@ -0,0 +1,26 @@
+"""
+Copyright (c) 2017 Fabian Affolter <fabian@affolter-engineering.ch>
+
+Licensed under MIT. All rights reserved.
+"""
+import asyncio
+import aiohttp
+
+from luftdaten import Luftdaten
+
+
+@asyncio.coroutine
+def main():
+    with aiohttp.ClientSession() as session:
+        data = Luftdaten(2154, loop, session)
+        yield from data.async_get_data()
+
+        # Print the sensor values
+        print("Sensor values:", data.values)
+
+        # Print the coordinates fo the sensor
+        print("Location:", data.meta['latitude'], data.meta['longitude'])
+
+
+loop = asyncio.get_event_loop()
+loop.run_until_complete(main())

luftdaten/__init__.py

@@ -0,0 +1,80 @@
+"""
+Copyright (c) 2017 Fabian Affolter <fabian@affolter-engineering.ch>
+
+Licensed under MIT. All rights reserved.
+"""
+import asyncio
+import logging
+
+import aiohttp
+import async_timeout
+
+from . import exceptions
+
+_LOGGER = logging.getLogger(__name__)
+_RESOURCE = 'https://api.luftdaten.info/v1'
+
+VOLUME_MICROGRAMS_PER_CUBIC_METER = 'µg/m3'
+
+SENSOR_TEMPERATURE = 'temperature'
+SENSOR_HUMIDITY = 'humidity'
+SENSOR_PM10 = 'P1'
+SENSOR_PM2_5 = 'P2'
+
+SENSOR_TYPES = {
+    SENSOR_TEMPERATURE: ['Temperature', '°C'],
+    SENSOR_HUMIDITY: ['Humidity', '%'],
+    SENSOR_PM10: ['PM10', VOLUME_MICROGRAMS_PER_CUBIC_METER],
+    SENSOR_PM2_5: ['PM2.5', VOLUME_MICROGRAMS_PER_CUBIC_METER]
+}
+
+
+class Luftdaten(object):
+    """A class for handling connections from Luftdaten.info."""
+
+    def __init__(self, sensor_id, loop, session):
+        """Initialize the connection."""
+        self._loop = loop
+        self._session = session
+        self.sensor_id = sensor_id
+        self.data = None
+        self.values = {
+                'humidity': None,
+                'P1': None,
+                'P2': None,
+                'pressure': None,
+                'temperature': None,
+            }
+        self.meta = {}
+
+    @asyncio.coroutine
+    def async_get_data(self):
+        url = '{}/{}/{}/'.format(_RESOURCE, 'sensor', self.sensor_id)
+
+        try:
+            with async_timeout.timeout(5, loop=self._loop):
+                response = yield from self._session.get(url)
+
+            _LOGGER.debug(
+                "Response from luftdaten.info: %s", response.status)
+            data = yield from response.json()
+            _LOGGER.debug(data)
+        except (asyncio.TimeoutError, aiohttp.ClientError):
+            _LOGGER.error("Can not load data from luftdaten.info")
+            raise exceptions.LuftdatenConnectionError()
+
+        try:
+            self.data = data
+
+            for sensor_data in self.data:
+                entry = sensor_data['sensordatavalues'][0]
+                for measurement in self.values.keys():
+                    if measurement == entry['value_type']:
+                        self.values[measurement] = float(entry['value'])
+
+            self.meta['sensor_id'] = self.sensor_id
+            self.meta['longitude'] = float(data[-1]['location']['longitude'])
+            self.meta['latitude'] = float(data[-1]['location']['latitude'])
+
+        except (TypeError, IndexError):
+            raise exceptions.LuftdatenError()

luftdaten/exceptions.py

@@ -0,0 +1,17 @@
+"""
+Copyright (c) 2017 Fabian Affolter <fabian@affolter-engineering.ch>
+
+Licensed under MIT. All rights reserved.
+"""
+
+
+class LuftdatenError(Exception):
+    """General LuftdatenError exception occurred."""
+
+    pass
+
+
+class LuftdatenConnectionError(LuftdatenError):
+    """When a connection error is encountered."""
+
+    pass

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.rst

setup.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+if sys.argv[-1] == 'publish':
+    os.system('python3 setup.py sdist upload')
+    sys.exit()
+
+setup(
+    name='luftdaten',
+    version='0.1',
+    description='Python API for interacting with luftdaten.info.',
+    url='https://github.com/fabaff/python-luftdatent',
+    download_url='https://github.com/fabaff/python-luftdaten/releases',
+    author='Fabian Affolter',
+    author_email='fabian@affolter-engineering.ch',
+    license='MIT',
+    install_requires=['aiohttp'],
+    packages=['luftdaten'],
+    zip_safe=True,
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX',
+        'Programming Language :: Python :: 3.4',
+        'Topic :: Utilities',
+    ],
+)