feat: Make it work in CLI mode

clementprevot · Nov 15, 2022 · b54f7ee · b54f7ee
1 parent 1243c3c
commit b54f7ee
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -166,21 +166,21 @@ Clone this repository to use the CLI.
 ### Integrated help
 
 ```bash
-python src/pyduro.py --help
+python -m pyduro --help
 ```
 
 ### Discover a burner
 
 ```bash
-python src/pyduro.py [discover]
+python -m pyduro [discover]
 ```
 
 The CLI will exit with 0 if a burner is found, 1 otherwise.
 
 ### Get information from a burner
 
 ```bash
-python src/pyduro.py -b <burner IP address> -s <burner serial number> -p <burner pin code> get <settings|range|operating|advanced|consumption|chart|logs|info|versions> "<path>"
+python -m pyduro -b <burner IP address> -s <burner serial number> -p <burner pin code> get <settings|range|operating|advanced|consumption|chart|logs|info|versions> "<path>"
 ```
 
 The result will be output as a JSON object that you can then manipulate with
@@ -227,7 +227,7 @@ error).
 **Examples**
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get operating
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 get operating
 
 > {
 > "NA": "38",
@@ -243,13 +243,13 @@ python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get operating
 ```
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get operating "boiler_ref"
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 get operating "boiler_ref"
 
 > "boiler_ref=19.0"
 ```
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.*"
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.*"
 
 > {
 > [...]
@@ -260,7 +260,7 @@ python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.*"
 ```
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.start"
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.start"
 
 > "start=0"
 ```
@@ -273,7 +273,7 @@ python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 get settings "misc.sta
 ### Update a burner's setting
 
 ```bash
-python src/pyduro.py -b <burner IP address> -s <burner serial number> -p <burner pin code> set settings "<path>" "<value>"
+python -m pyduro -b <burner IP address> -s <burner serial number> -p <burner pin code> set settings "<path>" "<value>"
 ```
 
 The CLI will exit with the return code return by the burner (0 = success, >0 =
@@ -282,9 +282,9 @@ error).
 **Examples**
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 set settings "misc.start" "1"
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 set settings "misc.start" "1"
 ```
 
 ```bash
-python src/pyduro.py -b 192.168.1.250 -s 1234 -p 12345678 set settings "misc.stop" "1"
+python -m pyduro -b 192.168.1.250 -s 1234 -p 12345678 set settings "misc.stop" "1"
 ```
diff --git a/setup.py b/setup.py
@@ -36,5 +36,5 @@
  py_modules=[],
  python_requires=">=3.6",
  url="https://github.com/clementprevot/pyduro",
- version="1.0.0",
+ version="1.1.0",
 )
diff --git a/src/pyduro/pyduro.py → src/pyduro/__main__.py b/src/pyduro/pyduro.py → src/pyduro/__main__.py
@@ -6,7 +6,7 @@
 import argparse
 import json
 
-from actions import ACTIONS, FUNCTIONS, discover, get, set
+from pyduro.actions import ACTIONS, FUNCTIONS, discover, get, set
 
 # -----------------------------------------------------------------------------------------------------------------------