Protobuf schema for claims on the LBRY blockchain

README.rst

lbryschema Build Test Coverage

lbryschema is a protobuf schema that defines how claims are structured and validated in the LBRY blockchain. There is also code to construct, parse, and validate lbry:// URIs.

Installation

To install lbryumschema, run the following command (use of a virtualenv is recommended):

pip install git+https://github.com/lbryio/lbryschema.git

Usage

See resources/schema.md in the lbry.tech repo.

Development

To install in development mode, check out this repository and inside it run:

pip install -r requirements.txt
pip install -e .

To run the tests:

cd tests/
python -m unittest discover -v

To re-compile the protobuf files (only necessary if you've changed any of the .proto files) you must first install the protoc tool.

On macOS this is done with brew command:

brew install protobuf

On Ubuntu you can install everything with apt-get:

sudo apt-get install protobuf-compiler python-protobuf

Once protobuf is installed, run ./build.sh script to compile the .proto files.