typo in instructions

[electricimp123]

From the instructions:

http://< YOUR-LOCAL-IP-ADDRESS >/6969/
should rather say
http://< YOUR-LOCAL-IP-ADDRESS >:6969/

[gridhead]

Thanks for pointing that out. That indeed was a typo. I have corrected it now. 🙂

[electricimp123]

One more thing that may help improve the documentation:

The instruction to install the dependencies (pip3 install -r requirements.txt) comes after activating the virtual environment. Subsequently, the instructions say to open a terminal and run the Sanctuary WebSockets Server. Thus the latter does not have access to any dependencies that needed to be installed because the former was done inside the virtual environment.

In my case, for instance, I had to install websockets a second time even though I correctly executed the dependency installation step.

A simple fix may be to move the step to install the dependencies prior to the step to activate the virtual environment.

[gridhead]

The virtualenv is a necessity for ensuring that the dependencies of the script serve the intended script only so when a new terminal is opened and a script is executed - it would require activation of that specific virtual environment.

The instruction to install the dependencies pip3 install -r requirements.txt comes after activating the virtual environment.

That is an intended instruction. This is to ensure that all the requirements that are fetched should be limited to these scripts only and not modify those of outside.

Subsequently, the instructions say to open a terminal and run the Sanctuary WebSockets Server. Thus the latter does not have access to any dependencies that needed to be installed because the former was done inside the virtual environment.

I appreciate your attention. That is indeed correct when you say that the Sanctuary WebSockets Server will not have access to the installed dependencies as previously they were done exclusively inside the virtual environment. We can simply fix that by activating the virtual environment for the other terminal first before running the server.

I have fixed that in the documentation now to make it more clear. 🙂