afk/parkerbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source 
Signed-off-by: Abdulkadir Furkan Şanlı <me@abdulocra.cy>
This commit is contained in:
Abdulkadir Furkan Şanlı 2024-01-21 10:46:40 +01:00
parent 2c82286bfe
commit 916067632d
Signed by: afk
SSH Key Fingerprint: SHA256:s1hULLl4YWdqU501MUfGe1CAG/m1pf9Cs6vFsqeTNHk
1 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -3,7 +3,7 @@
ParkerBot is a Matrix bot that monitors a channel for YouTube links and ParkerBot is a Matrix bot that monitors a channel for YouTube links and
generates weekly playlists from them. generates weekly playlists from them.
## Installation ## Running locally
1. Clone the repo 1. Clone the repo
2. Install the dependencies, preferably in a venv: 2. Install the dependencies, preferably in a venv:
@ -12,7 +12,21 @@ generates weekly playlists from them.
source ./venv/bin/activate source ./venv/bin/activate
pip3 install -r requirements.txt 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 ## Running as a container
1. Execute `main.py`: `./main.py` 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. ```shell
podman-compose up -d
```