automationLibs is a collection of Python packages that are created by ISG's Automation Squad. automationLibs aims to create boilerplate functions that will allow you to start coding immediately. Here is a list of other libraries:
- automationLibs_logger Library - Logger Library
- automationLibs_Gdrive Library - GDrive and GSheet helper Library
- automationLibs_PyAutoGUI Library - PyAutoGUI related Library
- automationLibs_Web Library - Selenium and other web related Library
- automationLibs_remote Library - sftp Library
- automationLibs_service Library - other helper Libraries
- Use the package manager pip to install automationLibs like below. Rerun this command to check for and install updates .
pip install git+https://gitlab.com/yasmin.barrientos/automationLibs_logger.git
pip install -e git+https://gitlab.com/yasmin.barrientos/automationLibs_logger#egg=automationLibs_logger
To install a specific branch
pip install -e git+https://gitlab.com/yasmin.barrientos/automationLibs_logger.git@dev-ver01#egg=automationlibs-logger-
Click the download link: https://gitlab.com/yasmin.barrientos/automationLibs_logger/-/archive/main/automationLibs_logger-main.zip to download the file
-
Install using pip
pip install <full path to folder>automationLibs_logger-main.zip- In your .ENV file, add the full path where you would like the logs to be created(could be anywhere:
#*** automationLibs_logger ***#
LOG_BASE_DIR="C:\\Users\\my_machine\\PycharmProjects\\my_project"- In your settings.py, initialize the logger
from loggerLibrary.logger import Logger
import getpass
LOG_NAME_ID = f'loggerLibrarytest_{getpass.getuser()}'
LOG_DIR = f'C:\\my_project\\logs\\'
logger = Logger(log_dir=LOG_DIR, log_id=LOG_NAME_ID).logger- Import settings.py to your other files
from common.settings import logger
logger.info('test')
logger.error('test')For more log formats, check here: https://docs.python.org/3/library/logging.html#logrecord-attributes
Features: Install this package to use a pre-formatted logger
| Argument | Required | Description |
|---|---|---|
| log_dir | Yes | Location of the Logs folder |
| log_id | Yes | ID Name of the logger. This will be used as the name of the log file. |
| set_logger_name | No | Name of the logger. Used when you are trying to refer to a specific log |
| show_logger_id | No | If set to Yes, the log_id will be visible in the logs. Useful when using multiple logs |
| enable_stdout | No | Use stdout instead of logging to output logs. Enable when deploying to cloud to see logs |
from loggerLibrary.logger import Logger
import getpass
LOG_NAME_ID = f'loggerLibrarytest_{getpass.getuser()}'
LOG_DIR = f'C:\\my_project\\logs\\'
logger = Logger(log_dir=LOG_DIR, log_id=LOG_NAME_ID).logger
logger.info('test info')
logger.error('test error')
logger.warning('test warning')-
File will be located in:
C:\my_project\logs\<year>\<month>\<LOG_NAME_ID>_<YYYY-MM-dd>.log -
Logger(LOG_NAME_ID).logger
- instantiates and creates the logger
e.g. C:\my_project\logs\2022\August\loggerLibrarytest_barri_2022-08-01.log
Result in PyCharm Terminal:
[2022-08-01 15:32:45,480] : [INFO] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:8] : test info;
[2022-08-01 15:32:45,480] : [ERROR] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:9] : test error;
[2022-08-01 15:32:45,480] : [WARNING] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:10] : test warning;
Result in Log File:
[2022-08-01 15:32:45,480] : [INFO] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:8] : test info;
[2022-08-01 15:32:45,480] : [ERROR] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:9] : test error;
[2022-08-01 15:32:45,480] : [WARNING] : [D:\DEV\PYTHON\automationLibs_logger\tests\test_logging.py:10] : test warning;
from loggerLibrary.logger import Logger
import getpass
LOG_NAME_ID = f'loggerLibrarytest_{getpass.getuser()}'
LOG_DIR = f'C:\\my_project\\logs\\'
logger = Logger(log_dir=LOG_DIR, log_id=LOG_NAME_ID, enable_stdout=True).logger
logger.info('test info')
logger.error('test info')Result in PyCharm Terminal:
[2022-08-01 15:48:39,076] : [INFO] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:16] : test info;
[2022-08-01 15:48:39,078] : [ERROR] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:17] : test error;
[2022-08-01 15:48:39,078] : [WARNING] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:18] : test warning;
Result in Log File:
[2022-08-01 15:48:39,076] : [INFO] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:16] : test info;
[2022-08-01 15:48:39,078] : [ERROR] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:17] : test error;
[2022-08-01 15:48:39,078] : [WARNING] : [D:/DEV/PYTHON/automationLibs_logger/tests/test_logging.py:18] : test warning;
from loggerLibrary.old_logger import OldLogger
import getpass
LOG_NAME_ID = f'loggerLibrarytest_{getpass.getuser()}'
logger2 = OldLogger(log_dir=2, log_name_id=LOG_NAME_ID).logger()
logger2.info('test info')
logger2.error('test info')Result in PyCharm Terminal:
[2022-03-28 17:56:30]: [INFO]: [test_logger.py:14] : test info;
[2022-03-28 17:56:30]: [ERROR]: [test_logger.py:15] : test info;
Result in Log File:
[2022-03-28 17:56:30]: [INFO]: [C:\DEV\PYTHON\PycharmProjects\loggerLibrary\tests\test_logger.py:14] : test info;
[2022-03-28 17:56:30]: [ERROR]: [C:\DEV\PYTHON\PycharmProjects\loggerLibrary\tests\test_logger.py:15] : test info;
- In your settings.py, initialize the logger
from loggerLibrary.logger import Logger
import getpass
LOG_NAME_ID = f'loggerLibrarytest_{getpass.getuser()}'
LOG_DIR = f'C:\\my_project\\logs\\'
logger = Logger(log_dir=LOG_DIR, log_id=LOG_NAME_ID).logger- Import settings.py to your other files
from common.settings import logger
logger.info('test')
logger.error('test')For more log formats, check here: https://docs.python.org/3/library/logging.html#logrecord-attributes