Add files via upload

.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+dist/
+*.egg-info/
+.coverage
+build/
+setup.cfg
+tg_logger.toml

README.md

@@ -1,36 +1,49 @@
-# tg_logger tool
-bridging python logging and user files to tg bot
-## Example
+# ![tg_logo](https://raw.githubusercontent.com/otter18/tg_logger/master/img/telegram-icon.png) Telegram logger
+[![](https://img.shields.io/pypi/v/tg-logger.svg)](https://pypi.org/project/tg-logger/)
+[![](https://img.shields.io/pypi/pyversions/tg-logger.svg)](https://pypi.org/project/tg-logger/)
+[![](https://img.shields.io/pypi/l/tg-logger.svg)](https://pypi.org/project/tg-logger/)
+
+Bridging python logging and files to tg bot
+
+## Installation & Usage
+- Available by `pip install tg-logger`
+- Use with `import tg_logger`
+
+## Examples
+### TgLogger example
 ```python
-#  Copyright (c) ChernV (@otter18), 2021.
-
 import logging
-
 import tg_logger
 
-# Logging format
-logging.basicConfig(format='%(asctime)s:%(name)s:%(levelname)s - %(message)s')
-formatter = logging.Formatter('%(name)s:%(levelname)s - %(message)s')
+# Telegram data
+token = "1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+users = [1111111111]
 
-# Setup TgLoggerHandler
-tg_handler = tg_logger.TgLoggerHandler(
-    token="1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",  # tg bot token
-    users=[111111111],  # list of user_id
-    timeout=10  # default value is 10 seconds
-)
-tg_handler.setFormatter(formatter)
-logger = logging.getLogger()
+# Base logger
+logger = logging.getLogger('foo')
 logger.setLevel(logging.INFO)
-logger.addHandler(tg_handler)
+
+# Logging bridge setup
+tg_logger.setup(logger, token=token, users=users)
 
 # Test
-logger.info("Hello from tg_logger by @chernykh_vladimir")
+logger.info("Hello from tg_logger by otter18")
+```
+
+### TgFileLogger example
+```python
+import logging
+import tg_logger
+
+# Telegram data
+token = "1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+users = [1111111111]
 
 # TgFileLogger example
 tg_files_logger = tg_logger.TgFileLogger(
-    token="1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",  # tg bot token
-    users=[111111111],  # list of user_id
-    timeout=10  # default is 10 seconds
+    token=token,  # tg bot token
+    users=users,  # list of user_id
+    timeout=10  # 10 seconds by default
 )
 
 file_name = "test.txt"
@@ -38,10 +51,7 @@ with open(file_name, 'w') as example_file:
     example_file.write("Hello from tg_logger by otter18")
 
 tg_files_logger.send(file_name, "Test file")
-
-# And one more time...
-logger.info("Finishing tg_logger demo")
-
 ```
-## Result
-![example_scr](/img/example_scr.jpg)
+
+### Example screenshot
+![example_scr](https://raw.githubusercontent.com/otter18/tg_logger/master/img/example_scr.png)

example.py

@@ -1,39 +0,0 @@
-#  Copyright (c) ChernV (@otter18), 2021.
-
-import logging
-
-import tg_logger
-
-# Logging format
-logging.basicConfig(format='%(asctime)s:%(name)s:%(levelname)s - %(message)s')
-formatter = logging.Formatter('%(name)s:%(levelname)s - %(message)s')
-
-# Setup TgLoggerHandler
-tg_handler = tg_logger.TgLoggerHandler(
-    token="1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",  # tg bot token
-    users=[111111111],  # list of user_id
-    timeout=10  # default value is 10 seconds
-)
-tg_handler.setFormatter(formatter)
-logger = logging.getLogger()
-logger.setLevel(logging.INFO)
-logger.addHandler(tg_handler)
-
-# Test
-logger.info("Hello from tg_logger by @chernykh_vladimir")
-
-# TgFileLogger example
-tg_files_logger = tg_logger.TgFileLogger(
-    token="1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",  # tg bot token
-    users=[111111111],  # list of user_id
-    timeout=10  # default is 10 seconds
-)
-
-file_name = "test.txt"
-with open(file_name, 'w') as example_file:
-    example_file.write("Hello from tg_logger by otter18")
-
-tg_files_logger.send(file_name, "Test file")
-
-# And one more time...
-logger.info("Finishing tg_logger demo")

example/example.py

@@ -0,0 +1,35 @@
+#  Copyright (c) ChernV (@otter18), 2021.
+
+import logging
+
+import tg_logger
+
+# Telegram data
+token = "1234567890:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+users = [1111111111]
+
+# Base logger
+logger = logging.getLogger('foo')
+logger.setLevel(logging.INFO)
+
+# Logging bridge setup
+tg_logger.setup(logger, token=token, users=users)
+
+# Test
+logger.info("Hello from tg_logger by otter18")
+
+# TgFileLogger example
+tg_files_logger = tg_logger.TgFileLogger(
+    token=token,  # tg bot token
+    users=users,  # list of user_id
+    timeout=10  # default is 10 seconds
+)
+
+file_name = "test.txt"
+with open(file_name, 'w') as example_file:
+    example_file.write("Hello from tg_logger by otter18")
+
+tg_files_logger.send(file_name, "Test file")
+
+# And one more time...
+logger.info("Finishing tg_logger demo")

requirements.txt

@@ -1 +0,0 @@
-pytelegrambotapi

setup.py

@@ -0,0 +1,22 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="tg_logger",
+    version="3.0",
+    description="A tool to bridge python logging and user files to telegram bot",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author="ChernV (otter18)",
+    author_email="vchern185@gmail.com",
+    url="https://github.com/otter18/tg_logger",
+    packages=find_packages(),
+    install_requires=[
+        "pyTelegramBotAPI==3.7.6",
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.6',
+)

tg_logger/__init__.py

@@ -9,7 +9,35 @@ import telebot
 
 # logging setup
 logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
+
+
+def setup(base_logger: logging.Logger,
+          token: str = '',
+          users: List[int] = [],
+          timeout: int = 10,
+          tg_format: str = '<b>%(name)s:%(levelname)s</b> - <code>%(message)s</code>'):
+    """
+    Setup TgLogger
+
+    :param base_logger: base logging.Logger obj
+    :param token: tg bot token to log form
+    :param users: list of used_id to log to
+    :param timeout: seconds for retrying to send log if error occupied
+    :param tg_format: logging format for tg messages (html parse mode)
+
+    :return: None
+    """
+    # Logging format
+    formatter = logging.Formatter(tg_format)
+
+    # Setup TgLoggerHandler
+    tg_handler = TgLoggerHandler(
+        token=token,  # tg bot token
+        users=users,  # list of user_id
+        timeout=timeout  # default value is 10 seconds
+    )
+    tg_handler.setFormatter(formatter)
+    base_logger.addHandler(tg_handler)
 
 
 class TgLoggerHandler(StreamHandler):
@@ -17,7 +45,7 @@ class TgLoggerHandler(StreamHandler):
 
     def __init__(self, token: str, users: List[int], timeout: int = 10):
         """
-        Setup TgLoggerHandler tool
+        Setup TgLoggerHandler class
 
         :param token: tg bot token to log form
         :param users: list of used_id to log to
@@ -37,7 +65,7 @@ class TgLoggerHandler(StreamHandler):
             t0 = time()
             while time() - t0 < self.timeout:
                 try:
-                    self.bot.send_message(user_id, msg)
+                    self.bot.send_message(user_id, msg, parse_mode="HTML")
                     break
                 except Exception as ex:
                     logger.exception("Exception while sending %s to %s:", msg, user_id)
@@ -77,7 +105,7 @@ class TgFileLogger:
                 t0 = time()
                 while time() - t0 < self.timeout:
                     try:
-                        self.bot.send_document(user_id, data=data, caption=caption)
+                        self.bot.send_document(user_id, data=data, caption=caption, parse_mode="HTML")
                         logger.info("File %s successfully send to %s", file_path, user_id)
                         break
                     except Exception as ex: