forked from LBRYCommunity/lbry-sdk
49 lines
2.9 KiB
Markdown
49 lines
2.9 KiB
Markdown
# <img src="https://raw.githubusercontent.com/lbryio/lbry/master/lbry.png" alt="LBRY" width="48" height="36" /> LBRY [](https://travis-ci.org/lbryio/lbry) [](https://codecov.io/gh/lbryio/lbry)
|
|
|
|
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](https://github.com/lbryio/lbrycrd) 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](https://github.com/lbryio/lbry/releases) contains pre-built binaries of the latest release, pre-releases, and past releases for macOS, Debian-based Linux, and Windows. [Automated travis builds](http://build.lbry.io/daemon/) 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](https://lbry.tech/playground) 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](https://lbry.tech/api/sdk).
|
|
|
|
## Running from source
|
|
|
|
Installing from source is also relatively painless. Full instructions are in [INSTALL.md](INSTALL.md)
|
|
|
|
## Contributing
|
|
|
|
Contributions to this project are welcome, encouraged, and compensated. For more details, please check [this](https://lbry.io/faq/contributing) link.
|
|
|
|
## License
|
|
|
|
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
|
|
|
|
## Security
|
|
|
|
We take security seriously. Please contact security@lbry.io regarding any security issues. [Our GPG key is here](https://lbry.io/faq/gpg-key) if you need it.
|
|
|
|
## Contact
|
|
|
|
The primary contact for this project is [@jackrobison](mailto:jack@lbry.io).
|
|
|
|
## Additional information and links
|
|
|
|
The documentation for the API can be found [here](https://lbry.tech/api/sdk).
|
|
|
|
Daemon defaults, ports, and other settings are documented [here](https://lbry.tech/resources/daemon-settings).
|
|
|
|
Settings can be configured using a daemon-settings.yml file. An example can be found [here](https://github.com/lbryio/lbry/blob/master/example_daemon_settings.yml).
|