btclib_libsecp256k1

Browse GitHub Code Repository

Simple python bindings to libsecp256k1 (v0.2.0). It is intended to be used with the btclib library.

To install (and/or upgrade):

python -m pip install --upgrade btclib_libsecp256k1

Build, test, develop, and contribute

Some development tools are required to develop and test btclib_libsecp256k1; they can be installed with:

python -m pip install --upgrade -r requirements-dev.txt

The btclib_libsecp256k1 project includes libsecp256k1 as submodule in the secp256k1 folder. By default, when cloning a project you get the directories that contain submodules, but none of the files within them. You must run git submodule init to initialize your local configuration file, and git submodule update to fetch the submodule data and check out the appropriate commit.

$ git submodule init
Submodule 'secp256k1' (git@github.com:bitcoin-core/secp256k1.git) registered for path 'secp256k1'
$ git submodule update
Cloning into 'secp256k1'...

To build:

python setup.py sdist
python setup.py bdist_wheel --py-limited-api=cp36

Developers might also consider installing btclib_libsecp256k1 in editable way::

python -m pip install --upgrade -e ./

To test:

pytest

To measure the code coverage provided by tests:

pytest --cov-report term-missing:skip-covered --cov=btclib_libsecp256k1

Pre-commit hooks are provided, please check before a PR

pre-commit run --all-files