Documentation for installing is missing #3
Comments
|
It's not that missing as spread around, which is common problem. Then, there's vicious cycle - I don't want to make initial hacky ways to do it kind of "official docs" before there will be enough testing, but then people can't find any docs at all. So, please start here: and I'll look into adding something to README after all. |
|
Updating the README with a warning about how hacky it is should probably be enough, but at the moment it is very unclear. From what I understood, I should use |
|
Ok, I added basic instructions to README. They surely expect some familiarity with standard Python package installation process.
You can use it the same way as you use pip. This includes installing packages individually, or several at once, or using requirements file. Please refer to pip documentation. |
|
Thank you ! |
Q #1: Should this be in uasyncio package at all? Upstream doesn't have this. Pro: will be easier for people do discover (see e.g. micropython/micropython-lib#148) Q #2: This provides implements 2 ways to create a WS connections: 1) using start_ws_server(); 2) using wrapping existing StreamReader and StreamWriter. History: initial prototype of course used 2). But the idea was "it should be like the official start_server()!!1". But then I though how to integrate it e.g. with Picoweb, and became clear that 2) is the most flixble way. So, 1) is intended to be removed. Q #3: Uses native websocket module for read path, but has own write path due to micropython/micropython#3396 Q #4: Requires micropython/micropython-lib#227 due to micropython/micropython#3394 .
During development, following questions were posed, and subsequently, answered: Q #1: Should this be in uasyncio package at all? Upstream doesn't have this. Pro: will be easier for people do discover (see e.g. #148) A: uasyncio diverges more and more from asyncio, so if something is convinient for uasyncio, there's no need to look back at asyncio. Q #2: This provides implements 2 ways to create a WS connections: 1) using start_ws_server(); 2) using wrapping existing StreamReader and StreamWriter. History: initial prototype of course used 2). But the idea was "it should be like the official start_server()!!1". But then I though how to integrate it e.g. with Picoweb, and became clear that 2) is the most flixble way. So, 1) is intended to be removed. A: 1) was removed and is not part of the merged version of the patch. Q #3: Uses native websocket module for read path, but has own write path due to micropython/micropython#3396 A: So far, so good. Q #4: Requires #227 due to micropython/micropython#3394 . A: The prerequisite was merged.
I'd like to give micropython-lib a try, but I don't know how to build it and set it up.
Can you document the required steps ?
The text was updated successfully, but these errors were encountered: