LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity
The LBRY SDK for building decentralized, censorship resistant, monetized, digital content apps.
4547 commits 110 branches 641 tags 31 MiB
Python 99.8%
Shell 0.1%
Find a file
Victor Shyba a50657c472 add dockerfile and readme on how win docker builder is generated
2018-11-26 20:55:03 -05:00
.github Add GitHub pull request template 2018-10-30 10:27:47 -04:00
docs added alt text 2018-11-02 19:38:30 -04:00
lbrynet tests 2018-11-26 11:36:28 -05:00
scripts add dockerfile and readme on how win docker builder is generated 2018-11-26 20:55:03 -05:00
tests tests 2018-11-26 11:36:28 -05:00
.gitattributes use union merge on CHANGELOG.md 2017-02-20 21:37:50 -06:00
.gitignore renamed build binary to lbrynet and other cleanup 2018-08-24 11:40:41 -04:00
.pylintrc removed lbryschema references from scripts and copied lbryschema requirements into local setup.py 2018-11-04 10:50:15 -05:00
.travis.yml use vshyba/temporary_pyinstaller_32bits_py37:latest 2018-11-26 20:55:03 -05:00
CHANGELOG.md bump 2018-10-26 16:51:23 -04:00
CONTRIBUTING.md contributing 2017-09-28 08:14:36 -04:00
Dangerfile fix because the danger.systems code example was wrong 2017-02-07 23:08:35 -06:00
example_daemon_settings.yml add example daemon_settings.yml 2018-11-19 09:42:13 -05:00
INSTALL.md Update various typos & edits 2018-11-18 20:52:18 -05:00
lbry.png Remove icons directory (#1389) 2018-08-24 17:36:52 -04:00
LICENSE Update to reflect year 2018 2018-02-05 12:40:49 -08:00
mkdocs.yml added more social links 2018-11-18 10:29:47 -05:00
README.md adds sample config and links to settings documentation 2018-11-19 10:10:02 -05:00
setup.py drop pytest 2018-11-26 18:02:12 -05:00
tox.ini adds test for claims on abandoned channels 2018-11-26 11:32:41 -05:00

README.md

LBRY LBRY Build Status Test Coverage

LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized peer-to-peer network. It utilizes the LBRY blockchain as a global namespace and database of digital content. Blockchain entries contain searchable content metadata, identities, rights and access rules. LBRY also provides a data network that consists of peers (seeders) uploading and downloading data from other peers, possibly in exchange for payments, as well as a distributed hash table used by peers to discover other peers.

This project provides an SDK for building applications using the LBRY protocol. The SDK is written in Python 3.7+ using Twisted. For other languages or platforms, a JSON-RPC API is provided.

Installation

Our releases page contains pre-built binaries of the latest release, pre-releases, and past releases for macOS, Debian-based Linux, and Windows. Automated travis builds are also available for testing.

Usage

Run lbrynet start to launch the API server.

By default, lbrynet will provide a JSON-RPC server at http://localhost:5279. It is easy to interact with via cURL or sane programming languages.

Our quickstart guide provides a simple walkthrough and examples for learning.

With the daemon running, lbrynet commands will show you a list of commands.

The full API is documented here.

Running from source

Installing from source is also relatively painless. Full instructions are in INSTALL.md

Contributing

Contributions to this project are welcome, encouraged, and compensated. For more details, please check this link.

License

This project is MIT licensed. For the full license, see LICENSE.

Security

We take security seriously. Please contact security@lbry.io regarding any security issues. Our GPG key is here if you need it.

Contact

The primary contact for this project is @jackrobison.

Additional information and links

The documentation for the API can be found here.

Daemon defaults, ports, and other settings are documented here.

Settings can be configured using a daemon-settings.yml file. An example can be found here.