RsLogMod 0.1.0

A versatile logging module for Python projects

RsLogMod

RsLogMod is a Python logging module that helps manage log files with features like log rotation, custom log paths, and log levels. It's designed to be simple to use and configure, emphasizing flexibility.

Table of Contents

• Installation
• Getting Started
• Log Levels & Prefixes
• Customization
  • Set Log Folder Path
  • Set Maximum Log Size
  • Enable or Disable Log Rotation
• Configuration
• License

Installation

To install the module, use pip:

pip install rslogmod

Getting Started

Here’s a quick example to get you logging:

from RsLogMod import rlog

# Log a simple message
rlog(log_name='my_log', log_level=1, log_entry='This is a log entry.')

# Example output: [INFO] 2024-12-02 13:20: This is a log entry.

Explanation

• log_name: The name of the log file (e.g., my_log).
• log_level: The log level, where 1 typically corresponds to INFO.
• log_entry: The message you want to log.

This will create a log file named my_log.log (if it doesn't already exist) in the configured directory with the entry formatted as shown above.

Log Levels & Prefixes

RsLogMod supports several log levels, each with its own prefix:

• 0: [DEBUG]
  • For detailed debugging information.
• 1: [INFO]
  • For general information about program execution.
• 2: [ERROR]
  • For errors that occur during execution.
• 3: [CRITICAL]
  • For critical issues that need immediate attention.
• 4: [SEC-ALERT]
  • For security-related alerts.
• 5: [SEC-BREACH]
  • For security breaches or serious security issues.

Customization

To customize how RsLogMod operates, such as changing the log file directory, setting the maximum log file size, or enabling log rotation, you can use the RsManager class.

Using RsManager

Here's how you can customize various settings:

Set Log Folder Path

from RsLogMod import RsManager

# Create an RsManager instance
manager = RsManager()

# Set a new log folder path
manager.log_folder_path('/new/log/directory')

# Display the current configuration to verify changes
manager.display()

Set Maximum Log Size

from RsLogMod import RsManager

# Create an RsManager instance
manager = RsManager()

# Set the max size for log files to 20 MB
manager.log_max_size(20)

# Display the current configuration to verify changes
manager.display()

Enable or Disable Log Rotation

from RsLogMod import RsManager

# Create an RsManager instance
manager = RsManager()

# Enable log rotation
manager.log_rotation(True)

# Display the current configuration to verify changes
manager.display()

Explanation

• RsManager: This class handles the configuration settings for RsLogMod, such as where log files are stored, how large they can grow before being rotated, and whether log rotation is enabled.
• log_folder_path(path: str): Sets the directory where logs are saved.
• log_max_size(mega_bytes: int): Sets the maximum size for log files in megabytes.
• log_rotation(value: bool): Enables or disables log rotation.

Configuration

RsLogMod uses a configs.json file for settings. Here’s an example:

{
    "log_rotation": false,
    "max_size_in_mega_bytes": 10,
    "out_dir": "/path/to/logs"
}

• log_rotation: Enable or disable log rotation.
• max_size_in_mega_bytes: The maximum size of a log file before it is rotated.
• out_dir: The directory where log files will be stored.

You can update these settings programmatically using the RsManager class, as shown in the examples above.

License

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