Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/classabbyamp/vidifierbot

A telegram bot for getting videos from URLs with yt-dlp
https://github.com/classabbyamp/vidifierbot

Last synced: about 1 month ago
JSON representation

A telegram bot for getting videos from URLs with yt-dlp

Awesome Lists containing this project

README

        

# VidifierBot

A telegram bot for getting videos from websites.

## Running

### Without docker or for development

Requires Python 3.10 or later.

To set up a virtualenv, install dependencies in it, and copy template files, run:

```
$ make install
```

Then, to run the bot, use:

```
$ sh run.sh
```

See [quick-bot-no-pain's documentation](https://github.com/0x5c/quick-bot-no-pain/blob/master/docs/run.sh.md) for more details.

### Docker

1. Create a new directory and `cd` into it.

2. Create the `docker-compose.yml` file:

```yaml
version: '3'
services:
bot:
image: "ghcr.io/classabbyamp/vidifierbot:latest"
restart: on-failure
volumes:
- "./data:/app/data:rw"
```

3. Create a subdirectory named `data`.

4. Copy the templates for `keys.py` and `help.md` to `data/`, and edit them.

5. Run `docker-compose`:

```none
$ docker-compose pull
$ docker-compose up -d
```

> Run without "-d" to test the bot. (run in foreground)

## Copyright

Copyright (C) 2021-2022 classabbyamp

This program is released under the terms of the BSD-3-Clause license.
See `LICENSE` for full license text.