telegram-pm 0.1.1__tar.gz → 0.1.3__tar.gz

{telegram_pm-0.1.1 → telegram_pm-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: telegram-pm
-Version: 0.1.1
+Version: 0.1.3
 Summary: Telegram preview page parser
 Author: Your Name
 Author-email: you@example.com
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 ![Python](https://img.shields.io/badge/python-3.12%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
 
-Tool for monitoring public Telegram channels available in WEB preview mode
+Telegram monitoring tool for public channels that can be viewed via WEB preview. Extracts data about messages and media files and stores all data in a database. No tokens or bots are required for monitoring. Just launch the app and collect information non-stop in the database.
 
 ## 🌟 Features
 1. [x] Parsing recent messages from public Telegram channels
@@ -85,7 +85,7 @@ poetry install
 | `--verbose`/`--v`                 | Verbose mode                                                          | ➖                                                              |
 | `--help`/`--h`                    | Help information                                                      | ➖                                                              |
 
-**Poetry**:
+**Poetry:**
 ```bash
 poetry run tpm --ch freegaza --ch BREAKINGNewsTG --db-path .\tg.db --v
 ```
@@ -93,7 +93,7 @@ or
 ```bash
 poetry run tpm --channels-filepath /path/to/monitoring_usernames.txt --db-path .\tg.db
 ```
-**Docker**:
+**Docker:**
 ```bash
 docker run -it --rm tpm --ch freegaza --db-path test_tg.db --v
 ```
@@ -109,6 +109,29 @@ docker run -it --rm \
     -v ~/tpm_data_dir/usernames.txt:/data/usernames.txt \
     telegram_pm --db-path /data/telegram_messages.sqlite --chf /data/usernames.txt
 ```
+**Python:**
+```python
+from telegram_pm.run import run_tpm
+
+
+run_tpm(
+    db_path="tg.db",                    # Path to sqlite database
+    channels=["channel1", "channel2"],  # Channels list
+    verbose=True,                       # Verbose mode
+
+    # Configuration (optional)
+    tg_iteration_in_preview_count=5,    # Number of requests (default 5). 20 messages per request. (1 iter - last 20 messages)
+    tg_sleep_time_seconds=60,           # Number of seconds after which the next process of receiving data from channels will begin (default 60 seconds)
+    tg_sleep_after_error_request=30,    # Waiting after a failed requests (default 30)
+    http_retries=3,                     # Number of repeated request attempts (default 3)
+    http_backoff=3,                     # Delay between attempts for failed requests (default 3 seconds)
+    http_timeout=60,                    # Waiting for a response (default 30 seconds)
+    http_headers={                      # HTTP headers
+        "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36"
+    }
+)
+```
+
 ## 🗃️ Database Structure
 
 The tables will be named as usernames. Each table is a username that was passed in the running parameters.

{telegram_pm-0.1.1 → telegram_pm-0.1.3}/README.md

@@ -3,7 +3,7 @@
 ![Python](https://img.shields.io/badge/python-3.12%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
 
-Tool for monitoring public Telegram channels available in WEB preview mode
+Telegram monitoring tool for public channels that can be viewed via WEB preview. Extracts data about messages and media files and stores all data in a database. No tokens or bots are required for monitoring. Just launch the app and collect information non-stop in the database.
 
 ## 🌟 Features
 1. [x] Parsing recent messages from public Telegram channels
@@ -65,7 +65,7 @@ poetry install
 | `--verbose`/`--v`                 | Verbose mode                                                          | ➖                                                              |
 | `--help`/`--h`                    | Help information                                                      | ➖                                                              |
 
-**Poetry**:
+**Poetry:**
 ```bash
 poetry run tpm --ch freegaza --ch BREAKINGNewsTG --db-path .\tg.db --v
 ```
@@ -73,7 +73,7 @@ or
 ```bash
 poetry run tpm --channels-filepath /path/to/monitoring_usernames.txt --db-path .\tg.db
 ```
-**Docker**:
+**Docker:**
 ```bash
 docker run -it --rm tpm --ch freegaza --db-path test_tg.db --v
 ```
@@ -89,6 +89,29 @@ docker run -it --rm \
     -v ~/tpm_data_dir/usernames.txt:/data/usernames.txt \
     telegram_pm --db-path /data/telegram_messages.sqlite --chf /data/usernames.txt
 ```
+**Python:**
+```python
+from telegram_pm.run import run_tpm
+
+
+run_tpm(
+    db_path="tg.db",                    # Path to sqlite database
+    channels=["channel1", "channel2"],  # Channels list
+    verbose=True,                       # Verbose mode
+
+    # Configuration (optional)
+    tg_iteration_in_preview_count=5,    # Number of requests (default 5). 20 messages per request. (1 iter - last 20 messages)
+    tg_sleep_time_seconds=60,           # Number of seconds after which the next process of receiving data from channels will begin (default 60 seconds)
+    tg_sleep_after_error_request=30,    # Waiting after a failed requests (default 30)
+    http_retries=3,                     # Number of repeated request attempts (default 3)
+    http_backoff=3,                     # Delay between attempts for failed requests (default 3 seconds)
+    http_timeout=60,                    # Waiting for a response (default 30 seconds)
+    http_headers={                      # HTTP headers
+        "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36"
+    }
+)
+```
+
 ## 🗃️ Database Structure
 
 The tables will be named as usernames. Each table is a username that was passed in the running parameters.

{telegram_pm-0.1.1 → telegram_pm-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "telegram-pm"
-version = "0.1.1"
+version = "0.1.3"
 description = "Telegram preview page parser"
 authors = [{name = "Your Name",email = "you@example.com"}]
 readme = "README.md"