README.md

BitLogs

Version 1.0.1

This python library allows you to easily create logs for your code.

Installation instructions

1. Open up your terminal
2. Run pip install bitlogs
3. Import it to your project (import bitlogs)

Example code

Code:

from bitlogs import Logger
from bitlogs.message_types.debug_message import DebugMessage

Logger.log(DebugMessage(), "Hello world!")

Output:

[DEBUG] Hello world!

---

Code:

from bitlogs import Logger
from bitlogs.message_types.critical_message import CriticalMessage


def add(a, b):
    if (not isinstance(a, float)) or (not isinstance(a, float)):
        Logger.log(CriticalMessage(), "A and B have to be of the type float.")
        # you should probably raise an error here
    return a + b

add(1, 2)

Output:

[CRITICAL] A and B have to be of the type float.

---

from bitlogs import Logger
from bitlogs.message_types.debug_message import DebugMessage

Logger.log_to_file(DebugMessage(), "Hello world!", "example.bitlog")

You can display the content of the file by running: cat example.bitlog on macOS + Linux and type example.bitlog on Windows