lbry-sdk/README.md

# <img src="https://raw.githubusercontent.com/lbryio/lbry/master/lbry.png" alt="LBRY" width="48" height="36" /> LBRY [![Build Status](https://travis-ci.org/lbryio/lbry.svg?branch=master)](https://travis-ci.org/lbryio/lbry) [![Test Coverage](https://codecov.io/gh/lbryio/lbry/branch/master/graph/badge.svg)](https://codecov.io/gh/lbryio/lbry)

LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized 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, and rights and access rules. LBRY also provides a data network that consists of peers uploading and downloading data from other peers, possibly in exchange for payments, and a distributed hash table, used by peers to discover other peers.

This project aims to provide a daemon that can interact with the network via a json-rpc interface over HTTP.

The project is written in Python 3.7+ and extensively uses Twisted framework.

## 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 daemon.

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](http://lbry.io/quickstart) provides a simple walkthrough and examples for learning.

The full API is documented [here](https://lbryio.github.io/lbry/cli).

## 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 PGP key is here 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.io/api).
Remove icons directory (#1389) * removed icons directory, saved 48x48.png icon to be the README.md icon * removed extra whitespace in lbry.png * point README to new icon 2018-08-24 23:36:52 +02:00			`# <img src="https://raw.githubusercontent.com/lbryio/lbry/master/lbry.png" alt="LBRY" width="48" height="36" /> LBRY [![Build Status](https://travis-ci.org/lbryio/lbry.svg?branch=master)](https://travis-ci.org/lbryio/lbry) [![Test Coverage](https://codecov.io/gh/lbryio/lbry/branch/master/graph/badge.svg)](https://codecov.io/gh/lbryio/lbry)`
:shipit: travis build badge :shipit: 2016-05-23 04:45:08 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized 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, and rights and access rules. LBRY also provides a data network that consists of peers uploading and downloading data from other peers, possibly in exchange for payments, and a distributed hash table, used by peers to discover other peers.
improvements to readme and install instructions (#396) * improvements to readme and install instructions * Update README.md * Update INSTALL.md 2017-01-10 00:01:50 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`This project aims to provide a daemon that can interact with the network via a json-rpc interface over HTTP.`
improvements to readme and install instructions (#396) * improvements to readme and install instructions * Update README.md * Update INSTALL.md 2017-01-10 00:01:50 +01:00
README and other post lbryum-refactor merge cleanup (#1388) * updated README with correct Python version, point code coverage to codecov, added header icon and fixed jacks email link * removed .appveyor.yml, requirements.txt, requirements_testing.txt 2018-08-24 22:44:26 +02:00			`The project is written in Python 3.7+ and extensively uses Twisted framework.`
update readme 2017-02-20 22:12:47 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Installation`
initial commit 2015-08-20 17:27:15 +02:00
Update README.md Fixed download links which were pointing to very outdated versions of daemon. 2018-08-26 06:10:38 +02:00			`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.`
update readme 2017-02-20 22:12:47 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Usage`
readme rewrite 2016-05-23 22:13:46 +02:00
README and other post lbryum-refactor merge cleanup (#1388) * updated README with correct Python version, point code coverage to codecov, added header icon and fixed jacks email link * removed .appveyor.yml, requirements.txt, requirements_testing.txt 2018-08-24 22:44:26 +02:00			Run `lbrynet start` to launch the daemon.
running and usage 2017-03-13 17:05:13 +01:00
README and other post lbryum-refactor merge cleanup (#1388) * updated README with correct Python version, point code coverage to codecov, added header icon and fixed jacks email link * removed .appveyor.yml, requirements.txt, requirements_testing.txt 2018-08-24 22:44:26 +02:00			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.
running and usage 2017-03-13 17:05:13 +01:00
no more free credits for learning 2017-07-05 22:28:41 +02:00			`Our [quickstart guide](http://lbry.io/quickstart) provides a simple walkthrough and examples for learning.`
running and usage 2017-03-13 17:05:13 +01:00
remove FAQ.md, update doc link in README.md 2017-11-29 18:17:04 +01:00			`The full API is documented [here](https://lbryio.github.io/lbry/cli).`
readme rewrite 2016-05-23 22:13:46 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Running from source`
improvements to readme and install instructions (#396) * improvements to readme and install instructions * Update README.md * Update INSTALL.md 2017-01-10 00:01:50 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`Installing from source is also relatively painless, full instructions are in [INSTALL.md](INSTALL.md)`
more readme cleanup 2017-03-13 17:14:02 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Contributing`
more readme cleanup 2017-03-13 17:14:02 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`Contributions to this project are welcome, encouraged, and compensated. For more details, please check [this](https://lbry.io/faq/contributing) link.`
update readme 2017-02-20 22:12:47 +01:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## License`
initial commit 2015-08-20 17:27:15 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`This project is MIT licensed. For the full license, see [LICENSE](LICENSE).`
initial commit 2015-08-20 17:27:15 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Security`
initial commit 2015-08-20 17:27:15 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is here if you need it.`
readme rewrite 2016-05-23 22:13:46 +02:00
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00			`## Contact`
initial commit 2015-08-20 17:27:15 +02:00
README and other post lbryum-refactor merge cleanup (#1388) * updated README with correct Python version, point code coverage to codecov, added header icon and fixed jacks email link * removed .appveyor.yml, requirements.txt, requirements_testing.txt 2018-08-24 22:44:26 +02:00			`The primary contact for this project is [@jackrobison](mailto:jack@lbry.io)`
Started to standardize the README.md file. Closes #1252 2018-06-18 20:56:07 +02:00
			`## Additional information and links`
initial commit 2015-08-20 17:27:15 +02:00
README and other post lbryum-refactor merge cleanup (#1388) * updated README with correct Python version, point code coverage to codecov, added header icon and fixed jacks email link * removed .appveyor.yml, requirements.txt, requirements_testing.txt 2018-08-24 22:44:26 +02:00			`The documentation for the api can be found [here](https://lbry.io/api).`