file organization prior to publication in pypi

IgnacioHR · Mar 30, 2022 · f8c2e8d · f8c2e8d
1 parent 4eabe7f
commit f8c2e8d
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 1 deletion.
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # diematic
 
 A Unix service written in Python to monitor De Dietrich boiler equiped with Diematic system using Modbus RS-845 protocol.
+The service reads data from the boiler and makes it available to be consumed in two ways:
 Optionally, the values fetched from the boiler are sent to an InfluxDB database.
 Optionally, a RESTful web server is installed and values can be obtained using GET and modified using POST requests.
 

diff --git a/diematic-server/__init__.py b/diematic-server/__init__.py
@@ -0,0 +1,9 @@
+"""
+Package definition for the diematic boiler.
+We are exposing only the Boiler class. Note that, in order to
+create an instance of the Boiler class it is required to read
+the configuration file in yaml format that will provide the
+registers available in your boiler. There is more information
+and examples in the diematicd.py file
+"""
+from boiler import Boiler
diff --git a/boiler.py → diematic-server/boiler.py b/boiler.py → diematic-server/boiler.py
diff --git a/diematicd.py → diematic-server/diematicd.py b/diematicd.py → diematic-server/diematicd.py
diff --git a/webserver.py → diematic-server/webserver.py b/webserver.py → diematic-server/webserver.py
diff --git a/diematic.yaml → etc/diematic.yaml b/diematic.yaml → etc/diematic.yaml
diff --git a/launcher.sh b/launcher.sh
@@ -4,4 +4,4 @@ WORKDIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
 cd $WORKDIR
 
 . ./venv/bin/activate
-python diematic.py start
+python diematic-server/diematic.py start
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
@@ -0,0 +1 @@
+"""Setup for the pipy package"""