py-bitcoinkernel

py-bitcoinkernel (or pbk in short) is a Python wrapper around libbitcoinkernel providing a clean, Pythonic interface while handling the low-level ctypes bindings and memory management.

Warning

py-bitcoinkernel is highly experimental software, and should in no way be used in software that is consensus-critical, deals with (mainnet) coins, or is generally used in any production environment.

Installation

To install a pre-compiled wheel from PyPI, simply run:

pip install py-bitcoinkernel

See the install section in the documentation for more information and alternative approaches.

Help

See the documentation for more information, usage examples, and more. You can serve the documentation locally. First install the dependencies:

pip install ".[docs,docs-test]"

Then generate and serve the documentation with:

mkdocs serve

Documentation coverage can be generated with interrogate, e.g.

interrogate src -v