Skip to content

Commit

Permalink
formatting: add more info on settings and debug log level, fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
Hukyl committed Nov 30, 2024
1 parent 606a218 commit 0623975
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This repo consists of two parts:

```bash
git clone <repo-url>
cd telegram-data-collector
cd telegram-data-collection
```

1. Install package manager used by the project - [Poetry](https://python-poetry.org/)
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions telegram_data_downloader/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"


Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 0623975

Please sign in to comment.