pyLogicx 0.2

Utility functions and logging system.

pyLogicx

pyLogicx is a Python library that provides utility functions for text processing and a configurable logging system. It is designed to assist developers with common text manipulation tasks while also providing a robust logging mechanism to track application behavior.

Features

• Logging Functionality:
  • Configurable logging levels (DEBUG, INFO, WARNING, ERROR) to track function calls and errors.
  • Output logs to console or a specified log file.

Installation

You can install the library using pip:

pip install pyLogicx

Usage

Importing the Library

You can import the utility functions and the logger as follows:

from pyLogicx.utils import track_time
from pyLogicx.logger import logger, set_log_level

Setting Log Level

You can configure the logging level at the beginning of your application:

set_log_level('DEBUG')  # Options: DEBUG, INFO, WARNING, ERROR

Example Functions

1. Count Words

This function tracks the time of function execution.

@track_time
def process_data():
    # Your code here

Logging Example

You can log messages at various levels using the logger & stored to the logger file:

logger.debug("This is a debug message.")
logger.info("This is an info message.")
logger.warning("This is a warning message.")
logger.error("This is an error message.")

Running Tests

To ensure that the library works as intended, you can run the tests located in the tests/ directory.

pytest tests/

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, feel free to submit an issue or a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any inquiries, you can reach me at [e-mail].