Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Pip requirements file. #39

Merged
merged 3 commits into from
Aug 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,29 +43,22 @@ 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!

## Installing

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
Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pyserial ~= 2.7
colorama ~= 0.3.6
websocket_client ~= 0.35.0