From 965147cd437e93fa6af585434a540fe0e5f09597 Mon Sep 17 00:00:00 2001 From: Bart Feenstra Date: Sat, 5 Aug 2017 21:56:43 +0200 Subject: [PATCH 1/3] Add a Pip requirements file. --- requirements.txt | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..447e41a --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +pyserial ~= 3.0 +colorama ~= 0.3.0 +websocket_client ~= 0.44.0 From 519cc10007033cef5944813924f9b8ed98deab63 Mon Sep 17 00:00:00 2001 From: Bart Feenstra Date: Sat, 5 Aug 2017 23:31:48 +0200 Subject: [PATCH 2/3] Update the Pip requirements to reflect those in the documentation. --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index 447e41a..4a46e32 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -pyserial ~= 3.0 -colorama ~= 0.3.0 -websocket_client ~= 0.44.0 +pyserial ~= 2.7 +colorama ~= 0.3.6 +websocket_client ~= 0.35.0 From 575fbe7646427b46ad6c36771e472d84878fc764 Mon Sep 17 00:00:00 2001 From: Bart Feenstra Date: Sat, 5 Aug 2017 23:31:58 +0200 Subject: [PATCH 3/3] Simplify the installation instructions. --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ad5f740..f52c7d5 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,9 @@ General: For the shell: * Python >= 2.7 or Python >= 3.4 -* The PySerial library >= 2.7 (sudo pip install pyserial) -* The colorama library >= 0.3.6 (sudo pip install colorama) -* The websocket-client library >= 0.35.0 (sudo pip install websocket-client) +* The PySerial, colorama, and websocket-client packages (`pip install -r requirements.txt`) -__IMPORTANT__: PySerial versions before 2.7 really don't work!!! It is highly -recommended to use PySerial version 3.x on Python2 and Python3. +__IMPORTANT__: It is highly recommended to use PySerial version 3.x on Python 2 and 3. __Note__: The tools only works if the REPL is accessible on the device! @@ -56,16 +53,12 @@ __Note__: The tools only works if the REPL is accessible on the device! To install this tool for __Python 2__, execute the following: - sudo pip install pyserial - sudo pip install colorama - sudo pip install websocket_client + sudo pip install -r requirements.txt sudo python setup.py install To install this tool for __Python 3__, execute the following: - sudo pip3 install pyserial - sudo pip3 install colorama - sudo pip3 install websocket_client + sudo pip3 install -r requirements.txt sudo python3 setup.py install ## Known Issues