Metadata-Version: 2.4
Name: automation-logging
Version: 0.1.1
Summary: Logging for automation, offering thread-safety, log cleanup and screenshot support.
Home-page: https://github.com/VBenevides/automation-logging
Author: Vinicius Benevides
Author-email: massaki1999@gmail.com
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: selenium
Requires-Dist: selenium; extra == "selenium"
Provides-Extra: pyautogui
Requires-Dist: pyautogui; extra == "pyautogui"
Requires-Dist: pyscreeze; extra == "pyautogui"
Requires-Dist: pillow; extra == "pyautogui"
Provides-Extra: all
Requires-Dist: selenium; extra == "all"
Requires-Dist: pyautogui; extra == "all"
Requires-Dist: pyscreeze; extra == "all"
Requires-Dist: pillow; extra == "all"
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: summary

# Automation Logging

## Overview 
Logging library for automation, offering thread-safety, log cleanup and screenshot support:
* **Thread-Safe Logging:** Ensures reliable and consistent logging from multi-threaded applications, preventing message corruption.
* **Automated Log Management:** Simplifies log file maintenance with configurable retention policies based on age or file count.
* **Seamless Integration:** Enables effortless integration with existing projects by allowing the library to override the standard `logging` module's root logger.
* **Integrated Screenshot Capture:** Captures informative screenshots directly within your logs, supporting full-screen captures (using `pyautogui`) and Selenium WebDriver screenshots, including headless browser support (using `selenium`).
* **Performance Profiling:** Capture elapsed and CPU times of functions using decorators and log the results.

-----------

## Instructions

### - How to create wheel

1. Create a virtual environment and install packages from build-requirements.txt
2. Activate the virtual environment
3. From the folder containing "setup.py", execute: `python setup.py bdist_wheel`
4. The wheel will be generated inside the `dist` folder
5. Install wheel using: `pip install dist/automation_logging[...].whl`

### - How to generate documentation

1. Create a virtual environment and install packages from build-requirements.txt
2. Activate the virtual environment
3. From the sphinx-doc folder, execute: `make html`
4. The documentation will be generated inside the `sphinx-doc/build/html` folder
5. To use the documentation, open the `index.html` file
