LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity
lbry-sdk/lbry
History
Victor Shyba c2106de7e1 refactor + tests
2019-12-11 12:06:41 -05:00
..
docs regenerate latest docs with claim_id argument to stream_repost 2019-11-20 10:56:42 -05:00
icons moved more lbry files into lbry dir 2019-06-20 22:50:39 -04:00
lbry refactor + tests 2019-12-11 12:06:41 -05:00
scripts move build-related files into top-level dir 2019-11-26 18:28:58 -05:00
tests refactor + tests 2019-12-11 12:06:41 -05:00
.dockerignore residual fixes after lbrynet -> lbry move 2019-06-20 22:50:39 -04:00
.gitattributes moved more lbry files into lbry dir 2019-06-20 22:50:39 -04:00
.gitignore move build-related files into top-level dir 2019-11-26 18:28:58 -05:00
.pylintrc pin to mypy==0.701 2019-06-20 22:50:39 -04:00
example_daemon_settings.yml moved lbrynet into lbry directory 2019-06-20 22:50:39 -04:00
lbry.png moved lbry.png into lbry 2019-06-20 22:50:39 -04:00
mkdocs.yml remaining lbry -> lbry-sdk changes 2019-06-20 23:13:57 -04:00
README.md drop codecov 2019-11-25 12:52:30 -05:00
setup.py downgrade multidict to prevent segfault 2019-12-11 09:44:37 -05:00
tox.ini added apsw installation to tox 2019-12-08 17:00:41 -05:00

README.md

LBRY LBRY SDK Build Status

LBRY is a decentralized peer-to-peer protocol for publishing and accessing digital content. 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.

LBRY SDK for Python is currently the most full featured implementation of the LBRY Network protocols and includes many useful components and tools for building decentralized applications. Primary features and components:

  • Built on Python 3.7+ and asyncio.
  • Kademlia DHT (Distributed Hash Table) implementation for finding peers to download from and announcing to peers what we have to host (lbry.dht).
  • Blob exchange protocol for transferring encrypted blobs of content and negotiating payments (lbry.blob_exchange).
  • Protobuf schema for encoding and decoding metadata stored on the blockchain (lbry.schema).
  • Wallet implementation for the LBRY blockchain (lbry.wallet).
  • Daemon with a JSON-RPC API to ease building end user applications in any language and for automating various tasks (lbry.extras.daemon).

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.com regarding any security issues. Our GPG key is here if you need it.

Contact

The primary contact for this project is @eukreign.

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.