xo-tokenizer2/xo-pywebutil
Roland Conybeare 3f1fd834d5 Add 'xo-pywebutil/' from commit '578b3d724a'
git-subtree-dir: xo-pywebutil
git-subtree-mainline: a2a8b936b9
git-subtree-split: 578b3d724a
2025-05-11 14:55:44 -05:00
..
.github/workflows Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
cmake Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
include Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
src/pywebutil Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
.gitignore Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
CMakeLists.txt Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
EXAMPLES Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00
README.md Add 'xo-pywebutil/' from commit '578b3d724a' 2025-05-11 14:55:44 -05:00

python bindings for c++ webutil library (xo-webutil)

Getting Started

build + install dependencies

build + install

$ cd xo-pywebutil
$ 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-pywebutil installed to ~/local2/lib

$ PYTHONPATH=~/local2/lib:$PYTHONPATH python
>>> import xo_pywebutil
>>> dir(xo_pywebutil)
['EndpointDescr', 'StreamEndpointDescr', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
>>> from xo_pywebutil import *

Development

build for unit test coverage

$ cd xo-pywebutil
$ 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-pywebutil
$ 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-pywebutil/build
$ cmake -LAH