bdkpython

The Python language bindings for the Bitcoin Development Kit

PyPI

Version: 2.2.0

Maintainers: 3

bdkpython

The Python language bindings for the bitcoindevkit.

See the package on PyPI.

Working with the submodule

This repository uses the bdk-ffi repository as a git submodule. Here are useful tips for working with the submodule:

When initially cloning the repo, the bdk-ffi submodule will be empty locally. You can intitiate/populate the directory by using the just submodule-init command.
If you make local changes to the bdk-ffi directory while developing and want to hard delete all changes and return to the exact committed version hash of the bdk-ffi repo, use the just submodule-reset command.

Local Testing and Usage

Start a Python virtual environment
Run one of the build script
Create the wheel
Install the library
Run the tests

source .localpythonenv/bin/activate

bash scripts/generate-macos-arm64.sh

python3 -m build --wheel --outdir dist --verbose 

pip3 install ./dist/bdkpython-<yourversion>.whl --force-reinstall

python3 -m unittest --verbose

Build HTML API Documentation (Optional)

Generate docs
Build HTML Documentation

python3 ./docs/generate_docs.py

python3 -m sphinx -b html -W --keep-going -v docs/source docs/_build/html

Keywords

FAQs

What is bdkpython?

Is bdkpython well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install