Skip to content

Commit a2acb01

Browse files
author
Kostya K
committed
Various corrections in README
1 parent f8ad1c0 commit a2acb01

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![GitHub version](https://badge.fury.io/gh/Kosat%2Ftelegram-messages-dump.svg)](https://github.com/Kosat/telegram-messages-dump/releases)
33
[![Build Status](https://travis-ci.org/Kosat/telegram-messages-dump.svg?branch=master)](https://travis-ci.org/Kosat/telegram-messages-dump)
44

5-
This is a simple console tool for dumping message history from a Telegram chat into a __jsonl__, __csv__ or plain text file.
5+
This is a simple console tool for dumping message history from a Telegram chat into a __jsonl__, __csv__ or plain __text__ file.
66
## Installation
77
**From sources:**
88
Fetch the latest sources with git:
@@ -26,7 +26,7 @@ Binaries for Linux, Windows and MacOS are available in [Releases](https://github
2626
## Usage
2727

2828
Mandatory parameters are <chat_name> e.g. @Python, @CSharp or a title of a dialogue, as seen in the UI, and <phone_num> - a telephone number. A phone number is needed for authentication and will not be stored anywhere. After the first successful authorization it will create telegram_chat_dump.session file containing auth token. The information from this file is being reused in next runs. If this is not a desirable behaviour, use -cl flag to delete session file on exit.
29-
>Note: You can use telegram dialogue user-friendly, multi-word title like so: `--chat=Moby & Docker CE. Русскоязычное сообщество` without extra quotes.
29+
>Note: You can use telegram dialogue multi-word title like so: `--chat="Telegram Geeks"` with double quotes. However, when using multi-word title (rather than @channel_name), you need to join the channel first. Only then you will be able to dump it.
3030
3131
```
3232
telegram-messages-dump -c <chat_name> -p <phone_num> [-l <count>] [-o <file>] [-cl]
@@ -62,24 +62,25 @@ For instance, if messages with ids 10..100 were saved in output file, the metafi
6262
telegram-messages-dump -p... -oC:\temp\xyz.txt --continue=100500 --exp=jsonl --chat=@geekschat
6363
```
6464
In both aforementioned cases, `telegram-messages-dump` will open the existing `C:\temp\xyz.txt` file and append the newer messages that were posted in the telegram chat since the message with the message with id 100500 was created.
65-
>Note: There must be `=` sign between the `--continue` command name and integer message id.
66-
>Note: In incremental mode without metafile, `--exp` and `--chat` must be specified explicitely as parameters. `--limit` setting has to be omitted.
65+
>Note1: There must be `=` sign between the `--continue` command name and integer message id.
66+
67+
>Note2: In incremental mode without metafile, `--out`, `--exp` and `--chat` must be specified explicitely as parameters. `--limit` setting has to be omitted.
6768
6869
## Notes
6970

7071
* This tool relies on [Telethon](https://github.com/LonamiWebs/Telethon) - a Telegram client implementation in Python.
7172

7273
## Plugins
7374

74-
Output format is managed by *exporter* plugins. Currently there are two exporters available: **text**,**jsonl** and **csv**.
75+
Output format is managed by *exporter* plugins. Currently there are two exporters available: **text**, **jsonl** and **csv**.
7576
Exporters reside in `./exporters` subfolder.
7677
Basically an exporter is a class that implements three methods:
7778
- `format(...)` that extracts all necessary data from a message and stringifies it.
7879
- `begin_final_file(...)` that allows an exporter to write a preamble to a resulting output file.
7980

8081
To use a custom exporter. Place you `.py` file with a class implementing those 3 methods into `./exporters` subfolder and specify its name in `--exp <exporter_name>` setting.
8182

82-
>Note: the class name **MUST** exactly match the file name of its `.py` file. This very same name is used as an argument for the `--exp` setting.
83+
>Note1: the class name **MUST** exactly match the file name of its `.py` file. This very same name is used as an argument for the `--exp` setting.
8384
8485
>Note2: in `.vscode` subfolder you can find the default settings that I use for debugging this project.
8586

0 commit comments

Comments
 (0)