v0.0.1

$${Com \color{red} py \color{black} le}$$

Keywords

APIs, Twitch, Youtube, MoviePy, OpenCV, MongoDB...

Requirements

1. Python, at least 3.10

2. Poetry, any stable version since 1.2 but idealy requires 1.3 or above
   https://python-poetry.org/docs/#installation

3. ImageMagick
   https://imagemagick.org/script/download.php

⚠️ Once you have installed it, ImageMagick should be automatically detected by MoviePy, except for some developers under specific OS:

• for windows users, you may also set the variable IMAGEMAGICK_BINARY from the moviepy config file. To avoid doing so, make sure to check "install legacy utilities" in the installation wizard.

• for ubuntu users (≥ 19.04), you may have installed from apt://imagemagick (or via the apt install command line), then you need to disable this line <policy domain="path" rights="none" pattern="@*"/> from the security policy file located at /etc/ImageMagick/policy.xml.

MoviePy additionally depends on the Python modules Numpy, imageio, Decorator, and tqdm, which will be automatically installed during MoviePy’s installation but it also needs extra common libraries like PIL, FFMPEG for specific usecases...

Getting started

Installation

1. Clone the repository

git clone https://github.com/amaurylrd/twitch_compyle.git
cd twitch_compyle/

2. Checkout the main branch

git checkout main

Setup

To setup this project, install the dependencies using poetry like so:

poetry lock
poetry install --sync

And, if you later need to update the dependencies accordingly to the pyproject.toml:

poetry lock
poetry update

Secondly refer to the configuration guide for a documentated overview on how to configure the .env file.

Run

To run the project and list the possible sub-commands, run the following command in a poetry shell:

python sources/main.py -h

Getting addicted

🚧 Contribution

If you are interested in the project, check the development manual. Please refer to this guide for further information on how to get started on the project for developers and contributors.

📫 Contact

Tho we like postcards, we prefer emails : @adesvall, @amaurylrd (owner), @thomasabreudias

License

See the LICENSE file for licensing information

And don't forget to give the project a star! ⭐