Skip to content

Commit

Permalink
Split 'Setup' into 'Requirements' and 'Setup'
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianCoenen authored Apr 14, 2021
1 parent 9840362 commit 1461b32
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,31 @@ [email protected]
#fortnitebattleroyale #season4 #twitch
```

## Setup
## Requirements
This project requires [Poetry](https://python-poetry.org/) to install the required dependencies.
Check out [this link](https://python-poetry.org/docs/) to install Poetry on your operating system.

Make sure you have installed [Python](https://www.python.org/downloads/) 3.8! Otherwise Step 3 will let you know that you have no compatible Python version installed.

Additionally, this project requires [ffmpeg](https://ffmpeg.org/download.html) and [imagemagick](https://imagemagick.org/script/download.php#windows).

*Note: Make sure that imagemagick is not restricted by the path access policy. Make sure the line `<policy domain="path" rights="none" pattern="@*"/>` is NOT present in the imagemagick policy config (`/etc/ImageMagick-6/policy.xml` on Debian/Ubuntu, [Windows Guide](https://github.com/Zulko/moviepy/issues/378)). Comment out this line if it is found in the file.*
There are a few additional steps depending on the operating system that are listed below:

**Windows**
- Poetry
- installing might throw errors which can be resolved by following
[this](python-poetry/poetry#2681) solution
- you should use pip version ≥ 20.2.3 to avoid additional problems
- ffmpeg
- has to be added to the path so it can be accessed directly with the streamlink command
- imagemagick
- you have to change the the config_default as described [here](https://github.com/Zulko/moviepy/issues/378)

**Linux**
- imagemagick
- make sure the line `<policy domain="path" rights="none" pattern="@*"/>` is NOT present in the imagemagick policy config (`/etc/ImageMagick-6/policy.xml` on Debian/Ubuntu). Comment out this line if it is found in the file to ensure that imagemagick is not restricted by the path access policy.*

## Setup
1. Clone/Download this repository
2. Navigate to the root of the repository
3. Run ```poetry install``` to create a virtual environment with Poetry
Expand Down

0 comments on commit 1461b32

Please sign in to comment.