|
1 | | -# NewPipe Extractor |
2 | | - |
3 | | -[](https://github.com/TeamNewPipe/NewPipeExtractor/actions/workflows/ci.yml) [](https://jitpack.io/#TeamNewPipe/NewPipeExtractor) [JDoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) • [Documentation](https://teamnewpipe.github.io/documentation/) |
4 | | - |
5 | | -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. |
6 | | - |
7 | | -## Usage |
8 | | - |
9 | | -NewPipe Extractor is available at JitPack's Maven repo. |
10 | | - |
11 | | -If you're using Gradle, you could add NewPipe Extractor as a dependency with the following steps: |
12 | | - |
13 | | -1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`. |
14 | | -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). |
15 | | -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: |
16 | | - ``` |
17 | | -## Rules for NewPipeExtractor |
18 | | --keep class org.schabi.newpipe.extractor.timeago.patterns.** { *; } |
19 | | --keep class org.mozilla.javascript.** { *; } |
20 | | --keep class org.mozilla.classfile.ClassFileWriter |
21 | | --dontwarn org.mozilla.javascript.tools.** |
22 | | -``` |
23 | | - |
24 | | -**Note:** To use NewPipe Extractor in Android projects with a `minSdk` below 26, [API desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required. If the `minSdk` is below 19, the `desugar_jdk_libs_nio` artifact is required, which requires Android Gradle Plugin (AGP) version 7.4.0. |
25 | | - |
26 | | -### Testing changes |
27 | | - |
28 | | -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`: |
29 | | - |
30 | | -```groovy |
31 | | -includeBuild('../NewPipeExtractor') { |
32 | | - dependencySubstitution { |
33 | | - substitute module('com.github.TeamNewPipe:NewPipeExtractor') with project(':extractor') |
34 | | - } |
35 | | -} |
36 | | -``` |
37 | | - |
38 | | -Another approach would be to use the local Maven repository, here's a gist of how to use it: |
39 | | - |
40 | | -1. Add `mavenLocal()` in your project `repositories` list (usually as the first entry to give priority above the others). |
41 | | -2. It's _recommended_ that you change the `version` of this library (e.g. `LOCAL_SNAPSHOT`). |
42 | | -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`) |
43 | | -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'`) |
44 | | - |
45 | | -> 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. |
46 | | -
|
47 | | -## Supported sites |
48 | | - |
49 | | -The following sites are currently supported: |
50 | | - |
51 | | -- YouTube |
52 | | -- SoundCloud |
53 | | -- media.ccc.de |
54 | | -- PeerTube (no P2P) |
55 | | -- Bandcamp |
| 1 | +<h1 align="center"><b>Tubular Extractor</b></h2> |
| 2 | +<h4 align="center">A fork of <a href="https://github.com/TeamNewPipe/NewPipeExtractor/">NewPipeExtractor</a>, a library for extracting things from streaming sites. It is a core component of <a href="https://github.com/polymorphicshade/Tubular">Tubular</a>, but could be used independently. |
56 | 3 |
|
57 | 4 | ## License |
58 | | - |
59 | | -[](https://www.gnu.org/licenses/gpl-3.0.en.html) |
60 | | - |
61 | | -NewPipe Extractor is Free Software: You can use, study share and improve it at your |
62 | | -will. Specifically you can redistribute and/or modify it under the terms of the |
63 | | -[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as |
64 | | -published by the Free Software Foundation, either version 3 of the License, or |
65 | | -(at your option) any later version. |
| 5 | +[](https://www.gnu.org/licenses/gpl-3.0.en.html) |
0 commit comments