2021-12-06 13:04:15 -05:00
|
|
|
# bdk-python
|
|
|
|
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
|
|
|
|
|
2022-02-16 21:29:43 -05:00
|
|
|
See the [package on PyPI](https://pypi.org/project/bdkpython/).
|
2021-12-13 19:43:39 -05:00
|
|
|
|
|
|
|
## Install from PyPI
|
2021-12-07 10:12:30 -05:00
|
|
|
Install the latest release using
|
|
|
|
```shell
|
|
|
|
pip install bdkpython
|
|
|
|
```
|
|
|
|
|
|
|
|
## Run the tests
|
|
|
|
```shell
|
2023-03-01 10:52:02 -05:00
|
|
|
pip install --requirement requirements.txt
|
2023-06-30 16:18:27 -04:00
|
|
|
bash ./scripts/generate-linux.sh # here you should run the script appropriate for your platform
|
2023-03-01 10:52:02 -05:00
|
|
|
python setup.py bdist_wheel --verbose
|
2023-06-30 16:18:27 -04:00
|
|
|
pip install ./dist/bdkpython-<yourversion>.whl --force-reinstall
|
2022-06-23 15:21:48 -04:00
|
|
|
python -m unittest --verbose tests/test_bdk.py
|
2021-12-07 10:12:30 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
## Build the package
|
|
|
|
```shell
|
2022-11-03 11:32:32 -04:00
|
|
|
# Install dependencies
|
2022-05-06 15:24:41 -04:00
|
|
|
pip install --requirement requirements.txt
|
2022-02-16 21:29:43 -05:00
|
|
|
|
2023-06-30 16:18:27 -04:00
|
|
|
# Generate the bindings (use the script appropriate for your platform)
|
|
|
|
bash ./scripts/generate-linux.sh
|
2022-02-16 21:29:43 -05:00
|
|
|
|
2022-02-15 16:47:34 +01:00
|
|
|
# Build the wheel
|
2023-03-01 10:52:02 -05:00
|
|
|
python setup.py --verbose bdist_wheel
|
2021-12-07 10:12:30 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
## Install locally
|
|
|
|
```shell
|
2023-06-30 16:18:27 -04:00
|
|
|
pip install ./dist/bdkpython-<yourversion>.whl
|
2021-12-07 10:12:30 -05:00
|
|
|
```
|