diff --git a/README.md b/README.md index 459f1b1..0be5bf4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,47 @@ -# tg_logger +# tg_logger tool bridging python logging and user files to tg bot +## 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') + +# 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") + +``` +## Result +![example_scr](/images/example_scr.png)