Go to file
wb9688 2d0c301440 Add another way to test changes locally to README.md 2020-04-01 15:43:11 +02:00
.github add contribution notes to extractor 2018-02-12 20:34:24 +01:00
extractor Merge pull request #298 from B0pol/feed_peertube 2020-03-28 12:53:47 +01:00
gradle/wrapper fix duration can not be paresd 2019-07-31 16:11:42 +02:00
timeago-parser Implement time ago parser and improve localization handling 2019-11-03 15:46:21 -03:00
.gitignore Ignore .iml files 2017-12-06 19:06:21 -06:00
.travis.yml use openjdk8 for travis build 2019-12-26 23:38:40 +01:00
LICENSE initial commit 2017-03-01 18:47:52 +01:00
README.md Add another way to test changes locally to README.md 2020-04-01 15:43:11 +02:00
build.gradle v0.19.0 2020-03-29 23:47:26 +02:00
copyright initial commit 2017-03-01 18:47:52 +01:00
gradlew fix duration can not be paresd 2019-07-31 16:11:42 +02:00
gradlew.bat fix duration can not be paresd 2019-07-31 16:11:42 +02:00
settings.gradle Created gradle module and moved existing code to new one 2018-03-14 00:44:02 -03:00

README.md

NewPipe Extractor

Build Status JIT Pack Badge Documentation

NewPipe Extractor is a library for extracting things from streaming sites. It is a core component of NewPipe, but could be used independently.

Usage

NewPipe Extractor is available at JitPack's Maven repo.

If you're using Gradle, you could add NewPipe Extractor as a dependency with the following steps:

  1. Add maven { url 'https://jitpack.io' } to the repositories in your build.gradle.
  2. Add implementation 'com.github.TeamNewPipe:NewPipeExtractor:v0.19.0'the dependencies in your build.gradle. Replace v0.19.0 with the latest release.

Testing changes

To test changes quickly you can build the library locally. A good approach would be to add something like the following to your settings.gradle:

includeBuild('../NewPipeExtractor') {
    dependencySubstitution {
        substitute module('com.github.TeamNewPipe:NewPipeExtractor') with project(':extractor')
    }
}

Another approach would be to use the local Maven repository, here's a gist of how to use it:

  1. Add mavenLocal() in your project repositories list (usually as the first entry to give priority above the others).
  2. It's recommended that you change the version of this library (e.g. LOCAL_SNAPSHOT).
  3. Run gradle's ìnstall task to deploy this library to your local repository (using the wrapper, present in the root of this project: ./gradlew install)
  4. Change the dependency version used in your project to match the one you chose in step 2 (implementation 'com.github.TeamNewPipe:NewPipeExtractor:LOCAL_SNAPSHOT')

Tip for Android Studio users: After you make changes and run the install task, use the menu option File → "Sync with File System" to refresh the library in your project.

Supported sites

The following sites are currently supported:

  • YouTube
  • SoundCloud
  • MediaCCC
  • PeerTube (no P2P)

License

GNU GPLv3 Image

NewPipe is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.