61ce041bda
More non-channel paths have been also added to the excluded custom name paths, documentation and exception messages have been improved and fixed in some places, and the licence header of YoutubeChannelLinkHandlerFactory has been moved to its beginning and updated. |
||
---|---|---|
.github | ||
checkstyle | ||
extractor | ||
gradle/wrapper | ||
timeago-parser | ||
.gitignore | ||
LICENSE | ||
README.md | ||
build.gradle | ||
gradlew | ||
gradlew.bat | ||
settings.gradle |
README.md
NewPipe Extractor
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:
- Add
maven { url 'https://jitpack.io' }
to therepositories
in yourbuild.gradle
. - Add
implementation 'com.github.TeamNewPipe:NewPipeExtractor:INSERT_VERSION_HERE'
to thedependencies
in yourbuild.gradle
. ReplaceINSERT_VERSION_HERE
with the latest release.
Note: To use NewPipe Extractor in projects with a minSdkVersion
below 26, API desugaring is required.
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:
- Add
mavenLocal()
in your projectrepositories
list (usually as the first entry to give priority above the others). - It's recommended that you change the
version
of this library (e.g.LOCAL_SNAPSHOT
). - 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
) - 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 optionFile → "Sync with File System"
to refresh the library in your project.
Supported sites
The following sites are currently supported:
- YouTube
- SoundCloud
- media.ccc.de
- PeerTube (no P2P)
- Bandcamp
License
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.