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-ffisubmodule will be empty locally. You can initiate/populate the directory by using thejust submodule-initcommand. - If you make local changes to the
bdk-ffidirectory while developing and want to hard delete all changes and return to the exact committed version hash of the bdk-ffi repo, use thejust submodule-resetcommand.
Prerequisites
Before building bdkpython locally, ensure you have installed the following tools:
- Rust toolchain (
rustup): Required to compilebdk-ffi. Install from rustup.rs. uv: Fast Python package installer and resolver. Install from Astral uv Docs.just(optional): Command runner used for repo tasks. Install viacargo install justor your system package manager.
Windows Users
- Windows: Rust's
x86_64-pc-windows-msvctarget needs the MSVC toolchain and Windows SDK.rustup-initoffers to install these for you; otherwise install Visual Studio Build Tools with the Desktop development with C++ workload. The build scripts are bash, so run them from Git Bash.
Local Testing and Usage
- Run one of the build scripts (skip the submodule update if you are making local changes to the
bdk-ffisubmodule) - Sync dependencies with
uv - Create the wheel
- Install the library
- Run the tests
1. Build Script Commands
Run the build script corresponding to your operating system:
Linux:
bash scripts/generate-linux.sh
macOS (Apple Silicon / ARM64):
bash scripts/generate-macos-arm64.sh
macOS (Intel / x86_64):
bash scripts/generate-macos-x86_64.sh
Windows (Git Bash / MSYS2):
bash scripts/generate-windows.sh
Note: Pass --skip-submodule-update if you are making local changes to bdk-ffi and wish to preserve them instead of resetting to the committed submodule hash.
2–5. Setup, Build, Install & Test Commands
# Sync dependencies with uv
uv sync
# Create the wheel
uv build --wheel -v
# Install the library
uv pip install ./dist/bdkpython-*.whl --force-reinstall
# Run the tests
uv run python -m unittest --verbose
Build HTML API Documentation (Optional)
- Generate docs
- Build HTML Documentation
uv run python ./docs/generate_docs.py
uv run python -m sphinx -b html -W --keep-going -v docs/source docs/_build/html
2 maintainers
Release files for bdkpython 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 83.2 MB
Release files / bdkpython-3.1.0-cp313-cp313-win_amd64.whl
| Download URL | bdkpython-3.1.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ae82e5652498934de975948c93cf4c4b15b0c67353be9d3240ade7e0a361ae13
|
|
BLAKE2b-256 checksum How to use checksums |
298ceabafce25c1d1606343871488090cd675a1d240898a111aa724d8ea67220
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp313-cp313-manylinux_2_28_x86_64.whl
| Download URL | bdkpython-3.1.0-cp313-cp313-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
471cea505bc4864f312adace5a45d850e4735005f5983525f34dd0a094746740
|
|
BLAKE2b-256 checksum How to use checksums |
a101b892923ce37c74755daf571796d5021aa01a32f2c1652300fa9d3ad35880
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp313-cp313-macosx_11_0_x86_64.whl
| Download URL | bdkpython-3.1.0-cp313-cp313-macosx_11_0_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.13 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
ef1717179ce550d79f604651b671b47ce0dcf4e5c7d7e3b3ff06c2a7581e1355
|
|
BLAKE2b-256 checksum How to use checksums |
130a7d5c6663ce7e1d8ab9b900edcfbcadcb6d2a476570b563eac0053351fc85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | bdkpython-3.1.0-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
9a30b50e57d3cbf49d70d70b64ab921000e92082819c68ae6d2cb271594c5049
|
|
BLAKE2b-256 checksum How to use checksums |
3556a45ce82650eb87d69c2b5df1bd1117c6fc14fedc285207038f0a21460649
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp312-cp312-win_amd64.whl
| Download URL | bdkpython-3.1.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
78d32172a362c53fe4f996c8233763c3ab61c191a3121d8be9ea806e57198239
|
|
BLAKE2b-256 checksum How to use checksums |
98bd3d9b76b62d0272370ec5a84b5aa05b1b0a5d5093d801dee95bf1c015eed7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | bdkpython-3.1.0-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
52e9bb008eebb68dcaa233516213038af793d1b675ee3c979e389026b2d5dc5f
|
|
BLAKE2b-256 checksum How to use checksums |
c447313a0ab267f313db119eaf24b75a57b4dada8513e5e3d93b6293f5cc574f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp312-cp312-macosx_11_0_x86_64.whl
| Download URL | bdkpython-3.1.0-cp312-cp312-macosx_11_0_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.12 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
31f981aeb57e59430725e5f105a4baf11a65e1a33f96e46030b65079f3217648
|
|
BLAKE2b-256 checksum How to use checksums |
7b81187d1acca2d99fe77162e6a9096394fe146cb23d4d0eae6abd36f3b656b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | bdkpython-3.1.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
fa50a9e0a689df669e034c113f103bd4ad1a267e1c21d6aa36b5d7f3eb8bfc61
|
|
BLAKE2b-256 checksum How to use checksums |
33577109f19cd332bda7edf6ad7fc55f8eb33bdfc8ec9033ff850a8cd895ab00
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp311-cp311-win_amd64.whl
| Download URL | bdkpython-3.1.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
a7c90c084e60a4fe158cfbdbd389d941e51f7306b55e1f09efc4a163fb6012e8
|
|
BLAKE2b-256 checksum How to use checksums |
5b456fcc226027437d9faeae2f7bc86c2db0f6fdbcba72dadab73638095be0ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp311-cp311-manylinux_2_28_x86_64.whl
| Download URL | bdkpython-3.1.0-cp311-cp311-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
cb1547a54afb10039018686eed42b0b14719e96f36e8ca24271d7fec26596d9b
|
|
BLAKE2b-256 checksum How to use checksums |
8e85635130df5c09dc71f030e88415c154802aba4403cd6ebffb2232b02a281c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp311-cp311-macosx_11_0_x86_64.whl
| Download URL | bdkpython-3.1.0-cp311-cp311-macosx_11_0_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.11 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
c4fa20ea60652836c07ed50068e7b50787b4aa647c3b8c8258d9772983d8a5f1
|
|
BLAKE2b-256 checksum How to use checksums |
1268b943e5280637722f9eb87c39e63b8303f01724ad8519f74d09c780ade731
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | bdkpython-3.1.0-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6dbed94febb69aa399f59934983a257da01d189b4c3a14a843742fc558905d7d
|
|
BLAKE2b-256 checksum How to use checksums |
70a3320414e98f2771a89e0737cfcb00fda9cea3e8efe7d61e0e864a032c00bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp310-cp310-win_amd64.whl
| Download URL | bdkpython-3.1.0-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 4.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
034e9a1a47d99d3019625170788f8b2565567aa35b2646946780b6b230028f91
|
|
BLAKE2b-256 checksum How to use checksums |
075aa8941038e64b279dec7fc0b4d05f4c1b45ede96858d9a7cf9d6beae44262
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp310-cp310-manylinux_2_28_x86_64.whl
| Download URL | bdkpython-3.1.0-cp310-cp310-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
0ff4a0d9d165349cb84ee0d6184baee9987a002999abd53e8854a006cbf98fc3
|
|
BLAKE2b-256 checksum How to use checksums |
6be1d669724e336daa36781c7e5be6fb718c6b8245ce18c72363332eed4a8955
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp310-cp310-macosx_11_0_x86_64.whl
| Download URL | bdkpython-3.1.0-cp310-cp310-macosx_11_0_x86_64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.10 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
75741215dceed52b57f01eb857c860b2683e2f692b7e625e05d5b4e0548981f3
|
|
BLAKE2b-256 checksum How to use checksums |
9cf3702df501142fc31f23f880868a0c937518727312d4fcb62c6f010da268b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / bdkpython-3.1.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | bdkpython-3.1.0-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.5 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
bda2e8b5d1eedd32f9616ccd614c376634809f2275eda8ffe5092b64b7c188a0
|
|
BLAKE2b-256 checksum How to use checksums |
f5f188e088ad13325e806cf1b73e8b883f7a7a5c83548275ef15e55f4f238530
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency log
