Roland Conybeare
ac77df2850
git-subtree-dir: xo-pywebsock git-subtree-mainline:605b0f6d36git-subtree-split:3ce41f42ca
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
# python bindings for c++ websocket library (xo-websock)
|
|
|
|
## Getting Started
|
|
|
|
### build + install dependencies
|
|
|
|
- [github/Rconybea/xo-websock](https://github.com/Rconybea/xo-websock)
|
|
- [github/Rconybea/xo-pyutil](https://github.com/Rconybea/xo-pyutil)
|
|
- [github/Rconybea/xo-pyreactor](https://github.com/Rconybea/xo-pyreactor)
|
|
|
|
### build + install
|
|
|
|
```
|
|
$ cd xo-pywebsock
|
|
$ mkdir build
|
|
$ cd build
|
|
$ INSTALL_PREFIX=/usr/local # or wherever you prefer, e.g. ~/local
|
|
$ cmake \
|
|
-DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake \
|
|
-DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} \
|
|
-DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} ..
|
|
$ make
|
|
$ make install
|
|
```
|
|
(also see .github/workflows/main.yml)
|
|
|
|
## Examples
|
|
|
|
Assumes `xo-pywebsock` installed to `~/local2/lib`
|
|
```
|
|
PYTHONPATH=~/local2/lib:$PYTHONPATH python
|
|
>>> import xo_pywebsock
|
|
>>> dir(xo_pywebsock)
|
|
['Runstate', 'Webserver', 'WebserverConfig', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'make_webserver']
|
|
>>>
|
|
```
|
|
|
|
## Development
|
|
|
|
### build for unit test coverage
|
|
```
|
|
$ cd xo-pywebsock
|
|
$ mkdir build-ccov
|
|
$ cd build-ccov
|
|
$ cmake \
|
|
-DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake \
|
|
-DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} \
|
|
-DCODE_COVERAGE=ON \
|
|
-DCMAKE_BUILD_TYPE=Debug ..
|
|
```
|
|
|
|
### LSP (language server) support
|
|
|
|
LSP looks for compile commands in the root of the source tree;
|
|
while Cmake creates them in the root of its build directory.
|
|
|
|
```
|
|
$ cd xo-pywebsock
|
|
$ ln -s build/compile_commands.json # supply compile commands to LSP
|
|
```
|
|
|
|
### display cmake variables
|
|
|
|
- `-L` list variables
|
|
- `-A` include 'advanced' variables
|
|
- `-H` include help text
|
|
|
|
```
|
|
$ cd xo-pywebsock/build
|
|
$ cmake -LAH
|
|
```
|