simbashlog-notify-helper-py: A Python3 package that is a helper for simbashlog notifiers

Description

simbashlog-notify-helper is a Python3 package designed to simplify the process of creating simbashlog notifiers.

Features

• Automatically handles and parses command-line arguments passed by simbashlog.
• Supports loading from both *.log files and *_log.json files.
  • Provides access to log data in a structured format using pandas DataFrames.
  • Summary generation.
• Provides access to log severity levels and their details based on RFC 5424 to create a more informative notifier.
• Provides functions so that validations are carried out and other aids that greatly simplify the creation of a notifier script.

Note: This package is designed to be used with simbashlog. If you are not familiar with simbashlog, please have a look at the "core" repository:

Getting Started

It is possible that pip is not yet installed. If this is not the case, you will be prompted to install it. Confirm the installation.

Installation with pip (GitHub)

pip install git+https://github.com/fuchs-fabian/simbashlog-notify-helper-py

Installation with pip (Local)

Download the repository and navigate to the directory containing the setup.py file.

pip install .

Check Installation

pip list

pip show simbashlog-notify-helper

Usage

#!/usr/bin/env python3

import simbashlog_notify_helper as snh # type: ignore

def main():
    # Process command-line arguments
    stored_log_info = snh.process_arguments()

    # Your notifier logic here (for more information, see the examples in the repository)
    # ...

if __name__ == "__main__":
    main()

Uninstall

pip uninstall simbashlog-notify-helper

Bugs, Suggestions, Feedback, and Needed Support

If you have any bugs, suggestions or feedback, feel free to create an issue or create a pull request with your changes.

Support Me

If you like simbashlog's ecosystem, you think it is useful and saves you a lot of work and nerves and lets you sleep better, please give it a star and consider donating.