Video downloader bot

Telegram bot for downloading videos from social networks.

Translation

Support services

• TikTok
  • Video
  • Music from video
  • Images
• YouTube
  • Shorts
  • Videos¹
• Reddit
  • Video without audio
  • Video with audio
• Twitter
  • Video
  • Images
• Instagram
  • Reels/video
  • Photo
  • Photo carousel
• Pinterest
  • Video
  • Images
• VK
  • Video
  • Images
  • Stories
  • Clips
• Vimeo
  • Video
  • Images
• Facebook
  • Video
  • Images

How to use?

Env variables

Name	Description	Default value	Required
TG_TOKEN	Telegram token for bot (you can get this in @BotFather)		✅ True
MONGO_URL	Url like mongodb://user:password@localhost:27017/video-downloader for using MongoDB.		✅ True
MONGO_DB	Name of MongoDB db like video-downloader		✅ True
BASE_PATH	Path to project	PROJECT_PATH	❌ False
DEFAULT_LOCALE	Default bot locale. Now support only en and ru	en	❌ False
LOCALE_DOMAIN	Domain of locale (need for i18n module)	message	❌ False
TZ	Timezone. Using for log	Europe/Moscow	❌ False
CONTACTS_PATH	Path to json file for contacts. More info	CONFIG_PATH/contacts.json	❌ False
NOTIFY_PATH	Default path for Notify module. More info	CONFIG_PATH/notify.json	❌ False
REPORT_PATH	Default path for file_reporter. More info	CONFIG_PATH/report.json	❌ False

Constant Path

These constants using for getting path to files. You can see these paths in this document.

Name	Description	Value
PROJECT_PATH	Real path to project	Project path (can't be override)
CONFIG_PATH	Path to config folder	$BASE_PATH/config
DATA_PATH	Path to data folder	$BASE_PATH/data
LOG_PATH	Path to log files	DATA_PATH/log
LOCALE_PATH	Path to localization data	PROJECT_PATH/locales

Contact info

This is .json file like this:

[
  {
    "type": "Author",
    "type_ru": "Автор",
    "text": "Jag_k",
    "url": "https://github.com/jag-k"
  },
  {
    "type": "Project GitHub Repo",
    "type_ru": "GitHub репозиторий проекта",
    "text": "@jag-k/tiktok-downloader",
    "url": "https://github.com/jag-k/tiktok-downloader"
  }
]

This file will be used in /help command.

You can image this like these structure:

Contacts:

- {type}: [{text}]({url})

Any of these fields can be internationalized. For this you need to set _{lang} suffix in keys. For example: type_ru or text_en. By default, using DEFAULT_LOCALE env variable or suffix-less key.

🔊 Notification service

This service can send notifications about errors and other events to different services.

Supported services

Support	Service	Code Name	Description	Events type support
✅	Save to file	file_reporter	Saving data to JSON file	REPORT
✅	Chanify	chanify	Chanify.net	Any
✅	Ntfy	ntfy	ntfy.sh	Any
❌	Pushsafer	pushsafer	pushsafer.com	Any
❌	Email	email	Email notification	Any
❌	Gotify	gotify	Gotify.net	Any
❌	Pushover	pushover	Pushover.net	Any
❌	PushBullet	pushbullet	PushBullet.com	Any
❌	Telegram	telegram	Telegram.org	Any
❌	Discord	discord	Discord.com	Any

• ✅ -- Full Supported now
• ❌ -- Not yet implemented

All supported events

• REPORT -- The user submits an error while parsing from inline
• EXCEPTION -- Bot catch exception on top level
• START -- Bot started
• STOP -- Bot stopped
• SHUTDOWN -- Bot shutdown

Configurate

Set env NOTIFY_PATH with a path to config. Default path is CONFIG_PATH/notify.json

Example of notify.json:

{
  // This is optional, used for validation in your IDE
  "$schema": "https://jag-k.github.io/tiktok-downloader/schemas/notify.schema.json",
  "services": [
    {
      "service": "file_reporter"
    },
    {
      "service": "file_reporter",
      "config": {
        "file_path": "/path/to/reporter/file.json"
      }
    },
    {
      "service": "chanify",
      "types": [
        "report"
      ],
      "config": {
        "url": "https://api.chanify.net",
        "token": "123"
      }
    },
    {
      "service": "chanify",
      "types": [
        "exception"
      ],
      "config": {
        "url": "https://api.example.com",
        "token": "456"
      }
    }
  ]
}

You can validate your config with JSON Schema. Link to schema

Module chanify

A wrapper for Chanify Notifications

Config:

Name	Description	Default value	Required
token	Chanify token		✅ True
url	Chanify server url	https://api.chanify.net	❌ False

Module file_reporter

Reporter that writes reports to a file.

Config:

Name	Description	Default value	Required
file_path	Path to report file	$REPORT_PATH	❌ False

Module ntfy

A wrapper for Ntfy Notifications

Config:

Name	Description	Default value	Required
url	Ntfy server url	https://ntfy.sh	❌ False
topic	Ntfy topic	tiktok-downloader	❌ False
token	Ntfy token	None	❌ False
token_type	Ntfy token type (Bearer or Basic)	Bearer	❌ False
send_file	Send file with notification	False	❌ False

Development

This project use Poetry for dependency management.

For database project use MongoDB. More about this you can read here.

Install project

Python version: 3.11 Poetry version: 1.4.1

poetry install
pre-commit install

Database

You can run docker-compose.yml with MongoDB for development.

Example of CONFIG_PATH/init-mongo.js file:

db.createUser(
  {
    user: "user",
    pwd: "password",
    roles: [
      {
        role: "readWrite",
        db: "video-downloader"
      }
    ]
  }
)

Example of .env file:

MONGO_URI=mongodb://user@password:localhost:27017/tiktok-downloader
MONGO_DB=tiktok-downloader

Run project

poetry run python main.py

Makefile commands

You can use this for updating I18n files, generate schemas and more.

make compile_locale  # Extract strings from code to .POT file
make extract_locale  # Update .PO file for Russian language
make update_locale  # Extract strings and update .PO file for Russian language
make full_update_locale  # Compile .PO files to .MO files
make generate_notify_schema  # Generate schema for notify.json file
make generate_notify_md  # Generate markdown for notify.json file
make generate_makefile  # Generate Makefile
make generate_makefile_md  # Generate Makefile and update README.md
make full_update_readme  # Full update README.md

Footnotes

1. Some videos can't be sent. Telegram have file limit (20 MB) for bots. ↩