README.md

Hyperledger Ursa BBS Signatures Wrapper for Python

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installing
    • Using pip
    • Manually
• Running tests

About

This is a Python wrapper for Hyperledger Ursa's C callable BBS+ package.

Getting Started

Prerequisites

• Python
• Pip
• Optional:
  • If you'd like to run the python tests
    • Install Pipenv
  • If you'd like to build the BBS+ library yourself
    • Install Rust
    • Follow installation instructions at https://github.com/mattrglobal/ffi-bbs-signatures

Installing

Using pip

pip install ursa-bbs-signatures

Manually

1. Build the Rust BBS+ library as described here
2. Place the resulting library (located in the target/debug directory) into the wrappers/python/ursa_bbs_signatures directory
3. Install the package into your environment by running python -m pip install <PATH TO THIS REPOITORY>/wrappers/python

Running tests

1. Make sure you have Pipenv installed
2. This project uses Pytest for testing, so make sure to install it by running pipenv install --dev in the wrappers/python directory
3. Run the tests using pipenv run test