From 0623975f39b9b12796945481b6f825d52dde697e Mon Sep 17 00:00:00 2001 From: Andrii Shalaiev Date: Sat, 30 Nov 2024 19:55:40 +0200 Subject: [PATCH] formatting: add more info on settings and debug log level, fix typo --- README.md | 4 +++- telegram_data_downloader/settings.py | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c51c23b..6b39c6b 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ This repo consists of two parts: ```bash git clone - cd telegram-data-collector + cd telegram-data-collection ``` 1. Install package manager used by the project - [Poetry](https://python-poetry.org/) @@ -78,6 +78,8 @@ This repo consists of two parts: For basic usage, you only need to fill in the `API_ID` and `API_HASH` values. These can be obtained from [my.telegram.org](https://my.telegram.org/apps). + _NOTE_: for detailed information on the message downloading progress, set "LOG_LEVEL" variable to "DEBUG". This allows the logs to include messages on per-chat downloading progress. + ## Usage 1. Activate the virtual environment diff --git a/telegram_data_downloader/settings.py b/telegram_data_downloader/settings.py index 5cd617f..a623aae 100644 --- a/telegram_data_downloader/settings.py +++ b/telegram_data_downloader/settings.py @@ -12,6 +12,7 @@ API_HASH = str(config("API_HASH", cast=str)) +# API version the client is using. Do not change unless you know what you are doing. CLIENT_SYSTEM_VERSION = "4.16.30-vxCUSTOM" @@ -71,8 +72,10 @@ # General running settings +# Set to "DEBUG" in config file for detailed info on per-chat download progress. LOG_LEVEL = config("LOG_LEVEL", default="INFO") +# Message formatting for logging. Do not change unless you know what you are doing. LOGGING = { "version": 1, "disable_existing_loggers": False,