Metadata-Version: 2.1
Name: buidl
Version: 0.2.14
Summary: An easy-to-use and fully featured bitcoin library written in pure python (no dependencies).
Home-page: https://github.com/buidl-bitcoin/buidl-python
Author: Example Author
Author-email: author@example.com
License: UNKNOWN
Description: # THIS REPOSITORY COMES WITH ZERO GUARANTEES! USE AT YOUR OWN RISK!
        
        `buidl` is a `python3` bitcoin library with no dependencies.
        It is easy-to-read and has extensive test coverage.
        Because `buidl` has no dependencies, it is easy to install on airgapped computers (just copy over this directory).
        
        ## Installation
        
        #### Online
        ```bash
        $ pip3 install buidl --upgrade
        ```
        
        #### Offline
        Download this repo and then run:
        ```bash
        $ python3 setup.py install
        ```
        
        ## Multiwallet
        `multiwallet` is a stateless CLI multisig PSBT wallet.
        Since `buidl` has no dependencies, you can run multiwallet by just `cd`ing to the root directory of this project:
        
        ```bash
        $ python3 multiwallet.py
        Welcome to multiwallet...
        ```
        
        If you have installed `buidl`, you can run `multiwallet.py` from any directory as follows:
        ```bash
        $ multiwallet.py
        Welcome to multiwallet...
        ```
        
        For more information on installing multiwallet, see [multiwallet.md](docs/multiwallet.md) or check out [this demo](https://twitter.com/mflaxman/status/1321503036724989952).
        
        ## Tests
        
        Run tests with `pytest`:
        ```bash
        $ git clone https://github.com/buidl-bitcoin/buidl-python.git && cd buidl-python
        $ pytest -v
        ```
        
        Run `black`:
        ```bash
        $ black . --diff --check
        ```
        
        Run `flake8`:
        ```bash
        $ flake8 .
        ```
        
        ## Performance
        
        You can speed this library up ~100x by using C-bindings to [bitcoin core's `libsecp256k1` library](https://github.com/bitcoin-core/secp256k1).
        
        #### OS Installation
        
        On Ubuntu:
        ```bash
        $ sudo apt install libsecp256k1-dev
        ```
        
        On MacOS (HT [cuber](https://github.com/cuber/homebrew-libsecp256k1)):
        ```bash
        $ brew tap cuber/homebrew-libsecp256k1 && brew install pkg-config libffi libsecp256k1
        ```
        
        #### Python Installation
        
        ```bash
        $ git clone git@github.com:buidl-bitcoin/buidl-python.git && cd buidl-python && python3 -m pip install -r requirements-libsec.txt && python3 -m pip install --editable . && cd buidl && python libsec_build.py && cd ..
        ```
        
        ## TODO:
        * Add libsec support/instructions to pypi version
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
