parkerbot/README.md
Abdulkadir Furkan Şanlı a181660836
Update README.md
Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
2024-01-21 10:48:27 +01:00

34 lines
805 B
Markdown

# ParkerBot
ParkerBot is a Matrix bot that monitors a channel for YouTube links and
generates weekly playlists from them.
## Running locally
1. Clone the repo
2. Install the dependencies, preferably in a venv:
```shell
python3 -m venv venv
source ./venv/bin/activate
pip3 install -r requirements.txt
```
3. Copy [example.env](example.env) to `.env`, customize it.
4. Source `.env`:
```shell
source .env
```
3. Execute the app:
```shell
./main.py
```
## Running as a container
1. Customize the compose.yml if necessary, you might want to change the data
volume's path or make it a named volume.
3. Copy [example.env](example.env) to `.env` and customize it.
2. Run the container, this is an example with `podman-compose`:
```shell
podman-compose up -d
```