@hive-staging/wax
v0.3.28
Published
Provides Hive Protocol features to JavaScript
Downloads
159
Readme
wax
An extension module to call hived cpp source code from Python and JavaScript.
Building
You need to install protobuf compiler first:
apt install protobuf-compiler
Python building and instaling
First, we need to have installed poetry
. To do that, simply type:
curl -sSL https://install.python-poetry.org | python3 - --version 1.6.1
Building
In order to build wax python package, one need to simply type from root project directory:
./scripts/build_wax_python.sh
This script will generate wheel file using virtual enviorement of poetry which will be saved in ./dist directory.
Instaling
It is recomended to create python virtual env, and install wax package it there, for example:
python3 -m venv venv
source ./venv/bin/activate
Now in order to install wax module to python, one need to type.
python3 -m pip install ./dist/CREATED-WAX-WHEEL.whl (for example wax-0.0.0-cp310-cp310-manylinux_2_35_x86_64.whl)
TypeScript Building
All of the required TypeScript-related information is available in the npm.ts.md file
Publishing a NPM package
Predefined package.json file has specified some dedicated placeholders to be replaced with actual informations before building a final form of a package and publishing it.
To replace such placeholders with actual values please use script/bump_npm_version.sh
.
Warning: Commiting a package.json file without such placeholder definitions is disallowed. See scripts/precommit_hook.sh for placeholder verification details.
Testing
Python Testing
For more info about examples, please check examples.
In order to run examples, just type:
./examples/python/run_example.sh
License
See license in the LICENSE.md file