Move all content in bdk-python subdirectory

This commit is contained in:
thunderbiscuit
2022-11-10 12:57:38 -05:00
parent 2a97218991
commit 413ca8bdeb
53 changed files with 2775 additions and 1 deletions

53
bdk-python/README.md Normal file
View File

@@ -0,0 +1,53 @@
# bdk-python
The Python language bindings for the [bitcoindevkit](https://github.com/bitcoindevkit).
See the [package on PyPI](https://pypi.org/project/bdkpython/).
<br/>
## Install from PyPI
Install the latest release using
```shell
pip install bdkpython
```
<br/>
## Run the tests
```shell
pip3 install --requirement requirements.txt
bash ./generate.sh
python3 setup.py --verbose bdist_wheel
pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl
python -m unittest --verbose tests/test_bdk.py
```
<br/>
## Build the package
```shell
# Install dependencies
pip install --requirement requirements.txt
# Generate the bindings first
bash generate.sh
# Build the wheel
python3 setup.py --verbose bdist_wheel
```
<br/>
## Run tox to build and test locally
```shell
# install dev requirements
pip install --requirement requirements-dev.txt
# build bindings glue code (located at ./src/bdkpython/bdk.py)
source ./generate.sh
# build and test
tox -vv
```
<br/>
## Install locally
```shell
pip install ./dist/bdkpython-<yourversion>-py3-none-any.whl
```