LBRYCommunity/lbry-android-sdk
1
0
Fork 0
Code Issues 1 Pull requests 5 Projects Releases 26 Packages Wiki Activity
The LBRY SDK packaged as an Android AAR library
714 commits 14 branches 27 tags 179 MiB
C 31.7%
Python 15.6%
Assembly 13.2%
Shell 11%
TeX 7.9%
Other 20.5%
Find a file
Akinwale Ariwodola e8a673ea4f rename build.lbry.io folder in CI
2020-02-20 23:17:41 +01:00
.github Update PULL_REQUEST_TEMPLATE.md 2019-10-28 10:29:43 -04:00
.gitsecret Replace Mixpanel with Firebase (Google) analytics (#535) 2019-05-02 07:06:42 +01:00
p4a update gitignore for .aar files 2020-02-20 12:18:44 +01:00
recipes Perf: Use of sort and sorted functions optimized (#748) 2019-11-25 11:28:16 +01:00
scripts build lbry sdk as an Android aar library 2020-02-20 12:09:29 +01:00
src/main sdk 0.60.0. update package.name in buildozer.spec 2020-02-20 14:00:52 +01:00
.dockerignore DOCKER-DEV: Local development in a docker container (#595) 2019-07-11 02:30:41 +01:00
.gitignore update gitignore for .aar files 2020-02-20 12:18:44 +01:00
.gitlab-ci.yml rename build.lbry.io folder in CI 2020-02-20 23:17:41 +01:00
.gitmodules remove submodule definition 2020-02-20 12:13:37 +01:00
build-debug.sh use /bin/bash for debug and release build scripts 2020-02-20 13:38:06 +01:00
build-release.sh use /bin/bash for debug and release build scripts 2020-02-20 13:38:06 +01:00
BUILD.md Update google-services.json path in BUILD.md #722 2019-10-20 16:28:06 +05:30
buildozer.spec.arm.ci sdk 0.60.0. update package.name in buildozer.spec 2020-02-20 14:00:52 +01:00
buildozer.spec.arm64.ci sdk 0.60.0. update package.name in buildozer.spec 2020-02-20 14:00:52 +01:00
buildozer.spec.sample sdk 0.60.0. update package.name in buildozer.spec 2020-02-20 14:00:52 +01:00
buildozer.spec.vagrant sdk 0.60.0. update package.name in buildozer.spec 2020-02-20 14:00:52 +01:00
DOCKER-DEV.md DOCKER-DEV: Add arm64 glibc headers from #606 2019-07-15 17:36:31 -04:00
DOCKER.md React Native codebase as a submodule (#604) 2019-07-09 05:34:46 +01:00
Dockerfile build lbry sdk as an Android aar library 2020-02-20 12:09:29 +01:00
lbry-android.keystore.enc Travis CI deployment to AWS and Github releases (#114) 2018-05-09 19:26:57 +01:00
LICENSE Update LICENSE 2020-02-03 04:38:17 +07:00
QUICKSTART.md Update QUICKSTART.md 2019-10-28 10:27:48 -04:00
README.md one more readme update 2020-02-20 12:38:38 +01:00
Vagrantfile add / update recipes and build changes for Python 3.6.6 compatibility (#315) 2018-10-07 15:59:03 +01:00

README.md

LBRY Android SDK

pipeline status GitHub license

The LBRY SDK packaged as an Android AAR library which can be used in any Android Studio project.

Installation

No installation required as this is a dev library.

Usage

  1. Open your project in Android Studio.
  2. File > New > New Module...
  3. Select Import .JAR / .AAR Package and click Next
  4. Select the lbrysdk-<version>-<debug|release>.aar package from the location you built or downloaded it to where version is the sdk version and <debug|release> is either debug or release.
  5. Click Finish
  6. Add implementation project(':lbrysdk-<version>-<debug|release>') to the build.gradle configuration for the main app module.

Using the SDK

Add the FOREGROUND_SERVICE and INTERNET permissions to AndroidManifest.xml if they are not yet added.

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.INTERNET" />

Add the android:usesCleartextTraffic="true" attribute to the application tag in AndroidManifest.xml. Import the required classes to be able to start up the service.

import io.lbry.lbrysdk.LbrynetService;
import io.lbry.lbrysdk.ServiceHelper;

Add code to launch the service.

Context context = getApplicationContext();
ServiceHelper.start(context, "", LbrynetService.class, "lbrynetservice");

Running from Source

The library can be built from source using Buildozer. After cloning the repository, copy buildozer.spec.sample to buildozer.spec and modify this file as necessary for your environment. Please see BUILD.md for detailed build instructions.

Contributing

Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing

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 PGP key is here if you need it.

Contact

The primary contact for this project is @akinwale (akinwale@lbry.com)