bdk-ffi/README.md

42 lines
674 B
Markdown
Raw Normal View History

2021-12-06 13:04:15 -05:00
# bdk-python
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
See the [package on PyPI](https://pypi.org/project/bdkpython/).
2021-12-13 19:43:39 -05:00
Currently supported architectures:
- macOS `arm64`
- macOS `x86_64`
- linux `x86_64`
<br/>
## Install from PyPI
Install the latest release using
```shell
pip install bdkpython
```
2021-12-07 10:25:42 -05:00
<br/>
## Run the tests
```shell
python -m tox
```
2021-12-07 10:25:42 -05:00
<br/>
## Build the package
```shell
# Install dependecies
pip install -r requirements.txt
# Generate the bindings first
bash generate.sh
# Build the wheel
python -m build
```
2021-12-07 10:25:42 -05:00
<br/>
## Install locally
```shell
pip install ./dist/bdkpython-0.0.1-py3-none-any.whl
```
2021-12-07 10:25:42 -05:00
<br/>