Skip to main content

Add your description here

Project description

UsefulLog

Yet another logging library - made by BravestCheetah, Used by BravestCheetah

The main class

Everything in this library builds upon the Logger class: from usefullog import Logger

The Logger Class

To use the tool you first gotta initialize an instance of the Logger class, you can do it just like this, including the name of the project:

logger = Logger("My Awesome Project")

When logging simple data like this: logger.log("cool logs") youll get some output like this:

2025-08-16 12:51:00 ( Test ) | [LOG] cool logs

There are other log formats too! Here they are:

.info("This is some info") - 2025-08-16 12:51:00 ( Test ) | [INFO] This is some info

.warn("You have been warned!") - 2025-08-16 12:51:00 ( Test ) | [WARN] You have been warned!

.error("Something went wrong :(") - 2025-08-16 12:51:00 ( Test ) | [ERROR] Something went wrong :(

.critical("CRITICAL ERROR") - 2025-08-16 12:51:00 ( Test ) | [CRITICAL] CRITICAL ERROR

.raw("only contents :O") - only contents :O

.space() - Newline (\n)

All logs are colored using the termcolor library which should be compatible with your terminal - Not visible in the documentation, but its there :D

Customization

But the logger does have multiple optional arguments to customize your logs. Lets list them:

1. Subname - Logger("My Awesome Project", sub_name="cool subsystem")

Result: 2025-08-16 12:55:19 ( Test/cool subsystem ) | [LOG] This is a test log

Useful for separating different systems or parts of your codebase for easier debugging.

2. Disable Timestamps - logger = Logger("Test", do_timestamps=False)

Result: ( Test ) | [LOG] This is a test log

Useful to declutter logs if timestamps arent necessary, makes the logs look more clean

3. Save Logs - logger = Logger("Test", do_log_saving=True)

Saves Logs Into .log files by default in the /logs folder. Each new instance of the Logger class creates a new log file.

Useful for saving and sharing logs

4. Disable Log Printing - logger = Logger("Test", print_logs=False)

Disables printing for logs, when paired with log saving you can safely store logs without filling the terminal.

5. Color Saved Logs - logger = Logger("Test", do_saved_log_decolouring=False)

When False the argument will keep the coloruing characters in the save folder, though most text editors may display these as normal characters and not colour them colours can be viewed when using a tool like cat to print the contents to the terminal directly.

6. Change Log Folder - logger = Logger("Test", log_save_folder="other folder")

When used logs will be saved in that path instead of the default /logs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

usefullog-0.8.3.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

usefullog-0.8.3-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file usefullog-0.8.3.tar.gz.

File metadata

  • Download URL: usefullog-0.8.3.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for usefullog-0.8.3.tar.gz
Algorithm Hash digest
SHA256 b7e084c58fc1018a5a64f8fb8c396af79d9c51633e220176b862832b66faed81
MD5 d87cc4d31ad96e2edf8a38cc2a53fab4
BLAKE2b-256 b3cbd108df7688dfb28bec9bccd016594bb612165712ed31be254cc4394fe83a

See more details on using hashes here.

File details

Details for the file usefullog-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: usefullog-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for usefullog-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e64538bb12d8e22f02a626eccf7a3bd260928bb6990da0e319a05bbb252ff897
MD5 4b03b45427e5297176f83d020bec767f
BLAKE2b-256 faaddeb34923f3a8f25a887fc51d164461cf2d5a53e77f1500b1289ff0f98391

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page