polyguard 1.0.1

A module that provides a set of swearwords to listen to when filtering while allowing to toggle on and off different languages.

polyguard

Take a look

This project now has automated documentation that gets generated, this manually written one will remain for legacy reasons, but you can now take a look at the automatic documentation here: https://hanra-s-work.github.io/polyguard/

Description

Table of Content

1. polyguard
2. Description
3. Table of Content
4. Installation
   1. Using pip
   2. Using python
5. Usage
   1. Running as a script
   2. Importing
   3. Initialising
6. Documentation
7. Author

Installation

Using pip

pip install -U polyguard

Using python

Under Windows:

py -m pip install -U polyguard

Under Linux/Mac OS:

python3 -m pip install -U polyguard

Usage

Running as a script

You can run polyguard directly as a script to start an interactive terminal session:

python -m polyguard

This will launch the interactive PolyGuard interface where you can execute commands.

Importing

from polyguard import PolyGuard

Initialising

The generic class is: PolyGuard(success: int = 0, error: int = 1, log: bool = True, debug: bool = False)

For your convenience, you can initialize the class with default parameters:

from polyguard import PolyGuard
ERROR = 1
SUCCESS = 0
LOG=True
DEBUG=False

polyguard_instance = PolyGuard(
    SUCCESS,
    ERROR,
    COLOUR_LIB,
    LOG,
    DEBUG
)
polyguard_instance()

Documentation

Comprehensive Doxygen-generated documentation is available online at https://hanra-s-work.github.io/polyguard/. This includes detailed API references, class documentation, and usage examples.

To generate the documentation locally, navigate to the doxygen_generation directory and run the provided scripts.

Author

This module was written by (c) Henry Letellier Attributions are appreciated.