https://github.com/bitcoindevkit/bdkpython
https://github.com/bitcoindevkit/bdkpython
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitcoindevkit/bdkpython
- Owner: bitcoindevkit
- License: other
- Created: 2025-07-10T19:25:05.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-07-31T15:38:39.000Z (11 months ago)
- Last Synced: 2025-07-31T19:07:06.131Z (11 months ago)
- Language: Python
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# bdkpython
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
See the [package on PyPI](https://pypi.org/project/bdkpython/).
# Working with the submodule
This repository uses the bdk-ffi repository as a git submodule. Here are useful tips for working with the submodule:
1. 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.
2. 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
1. Start a Python virtual environment
2. Run one of the build script
3. Create the wheel
4. Install the library
5. Run the tests
```sh
source .localpythonenv/bin/activate
bash scripts/generate-macos-arm64.sh
python3 setup.py bdist_wheel
pip3 install ./dist/bdkpython-.whl --force-reinstall
python3 -m unittest --verbose
```