Packaged using setuptools for PyPi pip installation

Author: Holger Fleischmann

README.md

@@ -7,24 +7,78 @@ Supported:
 * TSic 506
 * TSic 706
 
-The module `tsic.py` requires Python 3 and the great library `pigpio` for GPIO access with precise timing. 
+Don't forget the bypass capacitor as near as possible to the sensor's power supply pins to get stable behavior.
 
-Note: Python 2 will not work.
+## Dependencies
 
-It provides the following classes:
+The package `tsic` requires Python 3 and the great library `pigpio` for GPIO access with precise timing. Note that Python 2 will not work.
+
+## Installation
+
+Install from Python package index [PyPI](https://pypi.org):
+```
+pip3 install tsic
+```
+
+## Usage
+
+The module `tsic` provides the following classes:
 * `TsicInputChannel` receive temperature measurements
 * `Measurement` a temperature measurement
 * `TsicType` TSic type definition with instances `TSIC206`, `TSIC306`, `TSIC506`, `TSIC716` (206 and 306 are currently equivalent)
-* `ZacWireInputChannel` receive byte packets over ZACWire protocol (low-level handler for TsicInputChannel)
+* `ZacWireInputChannel` receive byte packets over ZACWire protocol (low-level handler for `TsicInputChannel`)
+
+### Command Line Test Tool
 
-See `example.py` for API usage or start `tsic.py <gpio-bcm> [--type {206,506,716,306}] [--loop]` to read temperatures from a GPIO pin (Broadcom numbering). See `tsic.py --help` for command line usage.
+Run `tsic <gpio-bcm> [--type {206,506,716,306}] [--loop]` to read temperatures from a GPIO pin (Broadcom numbering). See `tsic --help` for command line usage.
 
-Example:
 ```
-pi@raspi3:~/python-tsic $ sudo ./tsic.py 19 --type 306
+pi@raspi3:~ $ sudo tsic 19 --type 306
 Receiving data from TSic 206/306...
 Measurement 17.90°C at 2018-11-10 16:16:11.419573
 ```
 
-Greetings from Bavaria  
+### Examples 
+
+From file `example.py`:
+```python
+import time
+import pigpio
+
+from tsic import TsicInputChannel, Measurement, TSIC306
+
+# TsicInputChannel and ZacWireInputChannel require pigpio
+# for GPIO access with precise timing:
+pi = pigpio.pi()
+
+tsic = TsicInputChannel(pigpio_pi=pi, gpio=17, tsic_type=TSIC306)
+
+print('\nA. Single measurement:')
+print(tsic.measure_once(timeout=1.0))
+
+print('\nB. All measurements for 1 second:')
+tsic.start(lambda measurement: print(measurement))
+time.sleep(1)
+tsic.stop()
+
+print('\nC. One measurement per second for 3 seconds:')
+
+# start receiving in a context:
+with tsic:
+    for i in range(3):
+        time.sleep(1)
+        measurement = tsic.measurement
+        if measurement == Measurement.UNDEF:
+            print(measurement)
+        else:
+            print('{:d} {:.1f}°C'.format(i+1, measurement.degree_celsius))
+
+pi.stop()
+```
+
+## Source Code
+
+Hosted on [github.com/grillbaer/python-tsic](https://github.com/grillbaer/python-tsic)
+
+With greetings from Bavaria,
 Holger

example.py

@@ -6,12 +6,13 @@
 """
 
 __author__ = 'Holger Fleischmann'
-__copyright__ = 'Copyright 2018, Holger Fleischmann, Bavaria/Germany'
+__copyright__ = 'Copyright 2019, Holger Fleischmann, Bavaria/Germany'
 __license__ = 'Apache License 2.0'
 
+import time
 import pigpio
+
 from tsic import TsicInputChannel, Measurement, TSIC306
-import time
 
 # TsicInputChannel and ZacWireInputChannel require pigpio
 # for GPIO access with precise timing:

setup.py

@@ -0,0 +1,30 @@
+import setuptools
+
+with open("README.md", "r") as file:
+    long_description = file.read()
+
+setuptools.setup(
+    name="tsic",
+    version="1.2.0",
+    author="grillbaer",
+    author_email="holgflei+tsic@gmail.com",
+    description="Receive temperature readings from TSic 206/306/506/716 sensor chips on Raspberry Pi",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    keywords=['raspberrypi', 'raspberry', 'tsic', 'gpio', 'temperature', 'sensor'],
+    url="https://github.com/grillbaer/python-tsic",
+    packages=setuptools.find_packages(),
+    entry_points = {
+        'console_scripts': ['tsic=tsic.tsic:main']
+    },
+    install_requires=[
+        'pigpio'
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: Other OS",
+        "Topic :: Software Development :: Embedded Systems",
+        "Topic :: Scientific/Engineering :: Physics"
+    ]
+)

tsic/__init__.py

@@ -0,0 +1,3 @@
+__name__ = "tsic"
+
+from .tsic import *

tsic.py tsic/tsic.pytsic.py renamed to tsic/tsic.py

@@ -5,16 +5,26 @@
 May be used as a command line tool for testing TSIC input.
 """
 
-__all__ = [ 'ZacWireInputChannel', 'Measurement', 'TsicInputChannel', 'Error', 'PigpioNotConnectedError' ]
+__all__ = [
+    'ZacWireInputChannel', 
+    'Measurement',
+    'TsicInputChannel', 
+    'Error',
+    'PigpioNotConnectedError', 
+    'TSIC206',
+    'TSIC306',
+    'TSIC306',
+    'TSIC716'
+]
 
 __author__ = 'Holger Fleischmann'
-__copyright__ = 'Copyright 2018, Holger Fleischmann, Bavaria/Germany'
+__copyright__ = 'Copyright 2019, Holger Fleischmann, Bavaria/Germany'
 __license__ = 'Apache License 2.0'
 
 from datetime import datetime
 from functools import partial
-import argparse
 import logging
+import argparse
 
 import pigpio
 import threading
@@ -379,8 +389,7 @@ def __repr__(self, *args, **kwargs):
         return self.__class__.__name__ + ' for GPIO ' + str(self.__zacwire_channel.gpio)
 
 
-if __name__ == '__main__':
-    
+def main():
     tsic_types = { '206' : TSIC206,
                    '306' : TSIC306,
                    '506' : TSIC506,
@@ -413,3 +422,7 @@ def __repr__(self, *args, **kwargs):
         pass
     finally:
         pi.stop()
+
+
+if __name__ == '__main__':
+    main()