- prepare for PyPi packagin- prepare for PyPi packaging

Author: romor

README.md

@@ -8,8 +8,14 @@ It builds upon the [Python EnOcean](https://github.com/kipe/enocean) library.
 
 ## Installation ##
 
+enocean-mqtt is available on PyPI and can be installed using pip:
+ - sudo pip3 install enocean-mqtt
+
+Alternatively, install the latest release directly from github:
  - download this repository to an arbritary directory
  - install it using `python3 setup.py develop`
+
+Afterwards, perform configuration:
  - adapt the `enoceanmqtt.conf.sample` file and put it to /etc/enoceanmqtt.conf
    - set the enocean interface port
    - define the MQTT broker address

enoceanmqtt/communicator.py

@@ -1,3 +1,6 @@
+# Copyright (c) 2020 embyt GmbH. See LICENSE for further details.
+# Author: Roman Morawek <roman.morawek@embyt.com>
+"""this class handles the enocean and mqtt interfaces"""
 import logging
 import queue
 import numbers

enoceanmqtt/enoceanmqtt.py

@@ -1,4 +1,7 @@
 #!/usr/bin/env python3
+# Copyright (c) 2020 embyt GmbH. See LICENSE for further details.
+# Author: Roman Morawek <roman.morawek@embyt.com>
+"""this is the main entry point, which sets up the Communicator class"""
 import logging
 import sys
 import os

setup.py

@@ -1,34 +1,38 @@
+#!/usr/bin/env python3
+# Copyright (c) 2020 embyt GmbH. See LICENSE for further details.
+# Author: Roman Morawek <roman.morawek@embyt.com>
 """setup module for enoceanmqtt"""
-
-# prefer setuptools over distutils
-from setuptools import setup, find_packages
+import setuptools
 
 # needed packages
 REQUIRES = [
     'enocean',
     'paho-mqtt',
 ]
 
-setup(
-    name='enoceanmqtt',
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name='enocean-mqtt',
     version='0.1.0',
-    description='',
-    url='http://romor.github.io/enocean-mqtt',
     author='Roman Morawek',
-    author_email='maemo@morawek.at',
+    author_email='roman.morawek@embyt.com',
+    description='Receives messages from an enOcean serial interface (USB) and provides selected messages to an MQTT broker.',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url='https://github.com/embyt/enocean-mqtt',
     license='GPLv3',
 
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
     ],
     keywords='enOcean MQTT IoT',
-    packages=find_packages(exclude=['contrib', 'docs', 'tests*']),
+    packages=setuptools.find_packages(exclude=['contrib', 'docs', 'tests*']),
     install_requires=REQUIRES,
 
     # To provide executable scripts, use entry points in preference to the