Skip to main content

The cutest little logger you've ever seen.

Project description

Woodchips

The cutest little logger you've ever seen.

Build Status Coverage Status PyPi Licence

Showcase

Aren't logs just a bunch of woodchips?

Woodchips was created to be the cutest little logger you've ever seen. I wanted something dead simple and reusable as I found myself using the same logging setup over and over in projects. Woodchips gives you everything you need to setup the Python logging library in your project, all without the need to import or call on the logging package, know the various syntaxes for setting up handlers and formatters, etc which makes logging with Woodchips incredibly simple and clean.

Install

# Install tool
pip3 install woodchips

# Install locally
just install

Usage

  • A Logger instance must be created to use Woodchips. Simply specify a name and logging level, tell Woodchips where to log items (console and/or files), and start chipping away!
  • Need multiple loggers, no problem. Spin up separate Logger instances for your needs. Maybe you need a console logger for certain output that requires a specific format while another module needs a generic file formatter. Woodchips makes it easy to setup and configure all your loggers.
  • Logging to a file: Woodchips will automatically roll over your log files once it reaches the log_size. You can configure num_of_logs to specify how many log files will be kept in the rotation.
    • NOTE: Woodchips has a very small default log size of just 200kb with 5 log files for a total of 1mb of logs. For production applications, these values may need to be drastically increased.
  • Formatters: You can configure the format of log files per handler (console and/or files); however, defaults are set (and shown below) if you just need basic logging.

Setting up Woodchips

import woodchips

# Setup a new logger instance
logger = woodchips.Logger(
    name='my_logger_name',  # The name of your logger instance, often will be `__name__`
    level='INFO',  # The log level you want to use
)

# Setup console logging
logger.log_to_console(formatter='%(message)s')

# Setup file logging
logger.log_to_file(
    location='path/to/log_files',
    formatter='%(asctime)s - %(module)s.%(funcName)s - %(levelname)s - %(message)s',
    log_size=200000,  # Size of a single file in bytes
    num_of_logs=5,  # Number of log files to keep in the rotation
)

Using Woodchips

import woodchips

# Retrieve a logger instance by name (assumes it's already been created)
logger = woodchips.get('my_logger_name')

# Log a message (will be logged to console and a file based on the example from above)
logger.info('This is how to setup Woodchips!')

Logger Levels

  • CRITICAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG
  • NOTSET

Development

# Get a comprehensive list of development tools
just --list

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

woodchips-1.0.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

woodchips-1.0.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file woodchips-1.0.0.tar.gz.

File metadata

  • Download URL: woodchips-1.0.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for woodchips-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1837186797c933507ee4a822b17f7fec61db55ed6045c73b9d0350564984705c
MD5 83e836cf04adb92caebc2da50bf57e72
BLAKE2b-256 a2b781330431738c0a92cb0e716512b132c184058eef6d9d8ff0bc75b5ca21fb

See more details on using hashes here.

File details

Details for the file woodchips-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: woodchips-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for woodchips-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3074b7a881294c5d9ad1045f302cbefa154548d5d9b7938f043bf17fddc367e0
MD5 26f7aae24cf9c570952c3fb7e77d5250
BLAKE2b-256 3eea6d5d83925798c04987f15511bead53e81d809dee14eccf40ffc264ebdac8

See more details on using hashes here.

Supported by

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