summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README14
-rw-r--r--setup.py11
2 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index d87f3b8..a070a05 100644
--- a/README
+++ b/README
@@ -13,6 +13,20 @@ follows:
* `datetime` reads or updates the date and time of the device clock.
* `zero` deletes all the recorded readings (only implemented for few devices).
+## Example Usage
+
+Most of the drivers require optional dependencies, and those are listed in the
+table below. If you do not want to install the dependencies manually, you should
+be able to set this up using `virtualenv` and `pip`:
+
+```shell
+$ python3 -m venv $(pwd)/glucometerutils-venv
+$ . glucometerutils-venv/bin/activate
+(glucometerutils-venv) $ DRIVER=myglucometer-driver # see table below
+(glucometerutils-venv) $ pip install git+https://github.com/Flameeyes/glucometerutils.git#egg=project[${DRIVER}]
+(glucometerutils-venv) $ glucometer --driver ${DRIVER} help
+```
+
## Supported devices
Please see the following table for the driver for each device that is known and
diff --git a/setup.py b/setup.py
index 247a48b..2577ca0 100644
--- a/setup.py
+++ b/setup.py
@@ -29,6 +29,17 @@ setup(
],
extras_require = {
'test': ['abseil-py'],
+ # These are all the drivers' dependencies. Optional dependencies are
+ # listed as mandatory for the feature.
+ 'otultra2': ['pyserial'],
+ 'otultraeasy': ['pyserial'],
+ 'otverio2015': ['python-scsi'],
+ 'fsinsulinx': ['hidapi'],
+ 'fslibre': ['hidapi'],
+ 'fsoptium': ['hidapi'],
+ 'fsprecisionneo': ['hidapi'],
+ 'accucheck_reports': [],
+ 'sdcodefree': ['pyserial'],
},
entry_points = {
'console_scripts': [