https://github.com/teamnewpipe/newpipeextractor

NewPipe's core library for extracting data from streaming sites
https://github.com/teamnewpipe/newpipeextractor

bandcamp crawler extractor mediaccc newpipe peertube scraper soundcloud youtube

Last synced: 4 days ago
JSON representation

NewPipe's core library for extracting data from streaming sites

• Host: GitHub
• URL: https://github.com/teamnewpipe/newpipeextractor
• Owner: TeamNewPipe
• License: gpl-3.0
• Created: 2017-03-01T17:50:17.000Z (almost 8 years ago)
• Default Branch: dev
• Last Pushed: 2024-12-17T09:49:43.000Z (5 days ago)
• Last Synced: 2024-12-19T02:02:31.087Z (4 days ago)
• Topics: bandcamp, crawler, extractor, mediaccc, newpipe, peertube, scraper, soundcloud, youtube
• Language: Java
• Homepage:
• Size: 120 MB
• Stars: 1,404
• Watchers: 65
• Forks: 422
• Open Issues: 153
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NewPipe Extractor

[![CI](https://github.com/TeamNewPipe/NewPipeExtractor/actions/workflows/ci.yml/badge.svg?branch=dev&event=schedule)](https://github.com/TeamNewPipe/NewPipeExtractor/actions/workflows/ci.yml) [![JIT Pack Badge](https://jitpack.io/v/teamnewpipe/NewPipeExtractor.svg)](https://jitpack.io/#teamnewpipe/NewPipeExtractor) [JDoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) • [Documentation](https://teamnewpipe.github.io/documentation/)

NewPipe Extractor is a library for extracting things from streaming sites. It is a core component of [NewPipe](https://github.com/TeamNewPipe/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:INSERT_VERSION_HERE'` to the `dependencies` in your `build.gradle`. Replace `INSERT_VERSION_HERE` with the [latest release](https://github.com/TeamNewPipe/NewPipeExtractor/releases/latest).

3. If you are using tools to minimize your project, make sure to keep the files below, by e.g. adding the following lines to your proguard file:

 ```

## Rules for NewPipeExtractor

-keep class org.schabi.newpipe.extractor.timeago.patterns.** { *; }

-keep class org.mozilla.javascript.** { *; }

-keep class org.mozilla.classfile.ClassFileWriter

-dontwarn org.mozilla.javascript.tools.**

```

**Note:** To use NewPipe Extractor in Android projects with a `minSdk` below 33, [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) with the `desugar_jdk_libs_nio` artifact 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`:

```groovy

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

- media.ccc.de

- PeerTube (no P2P)

- Bandcamp

## License

[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)  

NewPipe Extractor 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](https://www.gnu.org/licenses/gpl.html) as

published by the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.