newpipe-documentation/docs/00_Prepare_everything.md

# Prepare everything

Welcome to the NewPipeExtractor documentation. This tutorial will guide you through the process of creating your own Extractor
service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud.
The whole documentation consists of this page, which explains the general concept of the NewPipeExtractor, as well as our
[Jdoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) setup.

__IMPORTANT!!!__ this is likely to be the worst documentation you have ever red, so do not hesitate to
[report](https://github.com/teamnewpipe/documentation/issues) if
you find any (spelling)errors, incomplete parts or you simply don't understand something. We are an open community
and are open for everyone to help :)

## Setup your dev environment

First and foremost you need to meet certain conditions in order to write your own service.

### What you need to know

- Basic understanding of __[git](https://try.github.io)__
- Good __[Java](https://whatpixel.com/best-java-books/)__ knowledge
- Good understanding of __[web technology](https://www.w3schools.com/)__
- Basic understanding about __[unit testing](https://www.vogella.com/tutorials/JUnit/article.html)__ and __[JUnit](https://junit.org/)__
- Flawless understanding of how to [contribute](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution) to the __NewPipe project__

### What you need to have

- A dev environment/ide that supports:
    - __[git](https://git-scm.com/downloads/guis)__
    - __[java 8](https://www.java.com/en/download/faq/java8.xml)__
    - __[gradle](https://gradle.org/)__
    - __[unit testing](https://junit.org/junit5/)__
    - I highly recommend [IDEA Community](https://www.jetbrains.com/idea/) since it has everything we need.
- A __[Github](https://github.com/)__ account
- A lot of patience and excitement ;D

After making sure all these conditions are provided fork the [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),
using the [fork button](https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box).
This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.
Next import the cloned project into your [IDE](https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project)
and [run](https://www.jetbrains.com/help/idea/performing-tests.html) it.
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.

#### Running test in Android Studio

Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle".
As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.

![tests passed on idea](img/prepare_tests_passed.png)

# Inclusion criteria for services

After creating you own service you will need to submit it to our [NewPipeExtractor](https://github.com/teamnewpipe/newpipeextractor)
 repository. However in order to include your changes you need to follow these rules:

1. Stick to our [Code contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution)
2. Do not send services that present content we [don't allow](#not-allowed-content) on NewPipe.
3. You need to be willing to keep on maintaining your service after submission.
4. Be patient and do the requested changes when one of our maintainers rejects your code.

## Allowed Content

- Basically anything except [NOT allowed content](#not-allowed-content).
- Any kind of porn/NSFW that is allowed according to the [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).
- Advertisement (may be handled specially tho)

## NOT allowed Content

- NSFL
- Porn that is not allowed according to [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).
- Any form of violence
- Child pornography
- Media that harms others
- Media that violates human rights
- Copyright infringement/pirated media
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00			`# Prepare everything`

fix some parts and add description about documentation 2018-11-10 10:00:20 +00:00			`Welcome to the NewPipeExtractor documentation. This tutorial will guide you through the process of creating your own Extractor`
			`service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud.`
			`The whole documentation consists of this page, which explains the general concept of the NewPipeExtractor, as well as our`
			`[Jdoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) setup.`

			`__IMPORTANT!!!__ this is likely to be the worst documentation you have ever red, so do not hesitate to`
			`[report](https://github.com/teamnewpipe/documentation/issues) if`
			`you find any (spelling)errors, incomplete parts or you simply don't understand something. We are an open community`
			`and are open for everyone to help :)`
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00
			`## Setup your dev environment`

			`First and foremost you need to meet certain conditions in order to write your own service.`

			`### What you need to know`

			`- Basic understanding of __[git](https://try.github.io)__`
add linkcheck script add travis control file test travis try fix travis try fix python version try fix dependency issue another try to fix travis another try to fix travis fuck travis bullshit try to fix test 2018-11-03 16:03:39 +00:00			`- Good __[Java](https://whatpixel.com/best-java-books/)__ knowledge`
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00			`- Good understanding of __[web technology](https://www.w3schools.com/)__`
add linkcheck script add travis control file test travis try fix travis try fix python version try fix dependency issue another try to fix travis another try to fix travis fuck travis bullshit try to fix test 2018-11-03 16:03:39 +00:00			`- Basic understanding about __[unit testing](https://www.vogella.com/tutorials/JUnit/article.html)__ and __[JUnit](https://junit.org/)__`
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00			`- Flawless understanding of how to [contribute](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution) to the __NewPipe project__`

			`### What you need to have`

			`- A dev environment/ide that supports:`
			`- __[git](https://git-scm.com/downloads/guis)__`
			`- __[java 8](https://www.java.com/en/download/faq/java8.xml)__`
			`- __[gradle](https://gradle.org/)__`
add unit testing to required environment 2018-04-09 10:20:31 +00:00			`- __[unit testing](https://junit.org/junit5/)__`
Fix spelling 2018-09-15 19:01:28 +00:00			`- I highly recommend [IDEA Community](https://www.jetbrains.com/idea/) since it has everything we need.`
			`- A __[Github](https://github.com/)__ account`
			`- A lot of patience and excitement ;D`
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00
			`After making sure all these conditions are provided fork the [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),`
			`using the [fork button](https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box).`
			`This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.`
Fix spelling 2018-09-15 19:01:28 +00:00			`Next import the cloned project into your [IDE](https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project)`
add Prepare Everything page add Prepare Everything page 2018-02-22 16:11:19 +00:00			`and [run](https://www.jetbrains.com/help/idea/performing-tests.html) it.`
			`If all the checks are green you did everything right, and you are good to go to move on to the next chapter.`
adds instruction on how to run tests in android studio If I ran the right tests in https://github.com/TeamNewPipe/NewPipeExtractor/pull/100#issuecomment-414696293, this should be the instructions 2018-08-21 14:45:45 +00:00
			`#### Running test in Android Studio`

			`Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle".`
			`As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.`

fix image paths 2018-11-16 18:23:01 +00:00			`![tests passed on idea](img/prepare_tests_passed.png)`
add inclusion criteria for services 2018-04-08 20:57:48 +00:00
			`# Inclusion criteria for services`

			`After creating you own service you will need to submit it to our [NewPipeExtractor](https://github.com/teamnewpipe/newpipeextractor)`
these 2018-04-08 21:02:12 +00:00			`repository. However in order to include your changes you need to follow these rules:`
add inclusion criteria for services 2018-04-08 20:57:48 +00:00
			`1. Stick to our [Code contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution)`
			`2. Do not send services that present content we [don't allow](#not-allowed-content) on NewPipe.`
			`3. You need to be willing to keep on maintaining your service after submission.`
			`4. Be patient and do the requested changes when one of our maintainers rejects your code.`

			`## Allowed Content`

			`- Basically anything except [NOT allowed content](#not-allowed-content).`
			`- Any kind of porn/NSFW that is allowed according to the [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).`
			`- Advertisement (may be handled specially tho)`

			`## NOT allowed Content`

			`- NSFL`
			`- Porn that is not allowed according to [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).`
			`- Any form of violence`
			`- Child pornography`
			`- Media that harms others`
that violates 2018-05-14 11:30:23 +00:00			`- Media that violates human rights`
add inclusion criteria for services 2018-04-08 20:57:48 +00:00			`- Copyright infringement/pirated media`