A lightweight logging package

Table of contents

Back to Top

Table of contents

Installation

• Using pip

  • Unix/mac/linux
  • Windows

• Building from source

  • Unix/mac/linux
  • Windows

Usage

• Creating a log
• Logging plaintext
• Logging debug information
• Logging information
• Logging warnings
• Logging errors

Getting help

Installation

Using pip

To install this package using pip, simply run the following command:

Unix/mac/linux

pip3 install woodchopper

Windows

pip install woodchopper

Building from source

Unix/mac/linux

Requirements

• Python >=3.8.1
• Git
• Poetry >=1.5.1

Run the following in the terminal:

git clone https://github.com/TinkerTown-SEMI/woodchopper.git
cd woodchopper

make install-dev
make -j4 all
make build

Windows

Requirements

• Python >=3.8.1
• Git
• Poetry >=1.5.1
• w64devkit (GNU binaries for windows, including make). When you extract the folder, add the folder to the path.

Run the following in the terminal:

git clone https://github.com/TinkerTown-SEMI/woodchopper.git
cd woodchopper

make install-dev
make -j4 all
make build

Usage

Creating a log

To use woodchopper, you first have to create a log.

from woodchopper import Logging_Levels, DateTime_Defaults, Styles, Logger
from pathlib import Path

log = Logger(
 Path("./spam.log").resolve(),  # Path to log file
 show_datetime=DateTime_Defaults.DO_NOT_SHOW,  # Don't show date and time. Other options: DateTime_Defaults.DATE_AND_TIME, DateTime_Defaults.DATE_ONLY, DateTime_Defaults.TIME_ONLY
 logging_level=Logging_Levels.DEBUG,  # Allow all logging operations. Other options: Logging_Levels.DEFAULT, Logging_Levels.WARNING, Logging_Levels.ERROR, Logging_Levels.SILENT.
 quiet=True  # Suppress log messages on creation and deletion.
)

Logging plaintext

log.log("Hello, world!")

Output

Hello, world!

Logging debug information

log.debug("Ate 1 can of spam. Cans of spam remaining: 25.")

Output¹

DEBUG: Ate 1 can of spam. Cans of spam remaining: 25.

Logging information

log.info("Sent order for 50 cans of spam.")

Output¹

INFO: Sent order for 50 cans of spam.

Logging warnings

log.warn("Running low on spam: 7 cans left.")

Output¹

WARNING: Running low on spam: 7 cans left.

Logging errors

log.error("Houston, we have a problem: cans of spam left: 0.")

Output¹

ERROR:  Houston, we have a problem: cans of spam left: 0.

Getting help

You can get help regarding this package in many ways. If you need help with syntax, your first stop should always be help manuals, so you could use python's built-in help function, as we do not yet have full documentation published(sorry). For errors, it should be the bug tracker, and for more generic python errors, you could go over to StackOverflow.

Happy logging, folks