Skip to main content

A color-coded JSON pretty printer for Python.

Project description

Colory PPrint

Colory PPrint is your new best friend when it comes to logging in Python—especially if you like your logs colorful, stylish, and super readable! Say goodbye to bland, hard-to-read logs and hello to clean, color-coded JSON logs with all the bells and whistles. Plus, it’s got your back when logging things that Python doesn't like to serialize.

Features:

  • 🎨 Color-coded JSON logs: Pick your foreground and background colors for that perfect contrast.
  • Text styles: Bold, underline, reverse, and even concealed—make your logs pop!
  • 🔧 Customizable: Tweak the logging to your heart’s content, perfect for debugging and visualizing data.
  • 🧩 Handles non-serializable objects: Logs things like custom classes by showing their type and memory address. Nothing gets left behind.

Installation

Getting Colory PPrint up and running is a breeze! Choose one of these two methods:

  1. From the GitHub repo directly:

    pip install git+https://github.com/ruhiddin/colory-pprint.git
    
  2. Alternatively, from PyPI (because we’re all about simplicity):

    pip install colory_pprint
    

Usage

Basic Usage:

Start logging with a simple import and one-liner. Like magic.

from colory_pprint import ColoryPPrint

log = ColoryPPrint(debug=True)

log({"message": "Hello, World!"})

Logging with Colors and Styles:

Why stick to plain text when you can have colorful, styled logs?

log.red.bold({"status": "error", "message": "Oops! Something went wrong."})
log.green.on_black.underline({"status": "success", "message": "All systems go!"})

Handling Non-Serializable Objects:

Got an object that Python doesn’t know how to handle? No worries. Colory PPrint logs it with style anyway, using the repr() function.

class CustomObject:
    def __init__(self, name: str, value: int):
        self.name = name
        self.value = value

custom_obj = CustomObject(name="Test", value=100)

log.red.bold({
    "status": "error",
    "message": "Something failed!",
    "object": custom_obj
})

The output will look something like this:

{
  "status": "error",
  "message": "Something failed!",
  "object": "<CustomObject object at 0x7f8a3f8b93d0>"
}

Available Colors:

Foreground: black, red, green, yellow, blue, magenta, cyan, white, grey, light_red, light_green, light_yellow, light_blue, light_magenta, light_cyan, light_white.
Background: on_black, on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, on_white, on_grey, on_light_red, on_light_green, on_light_yellow, on_light_blue, on_light_magenta, on_light_cyan, on_light_white.

Available Text Styles:

  • bold
  • underline
  • reverse
  • concealed

Debug Mode:

Got some tricky bugs? Turn on debug mode to see all the inner workings of your logging.

log = ColoryPPrint(debug=True)
log({"message": "Debug mode: ON! See everything in style."})

(Just remember to switch it off in production, unless you want your logs to throw a party.)

Now go on, add some color to those logs, and make debugging feel like a breeze!

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

colory_pprint-1.4.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

colory_pprint-1.4.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file colory_pprint-1.4.0.tar.gz.

File metadata

  • Download URL: colory_pprint-1.4.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for colory_pprint-1.4.0.tar.gz
Algorithm Hash digest
SHA256 f8e8bfc6e14c4bb64c717bc64c9484ef677a35a7954c07f65529e7676d50037f
MD5 edb1bd1d04fb0f5ac55b6fee149c5f6e
BLAKE2b-256 404b3e6af29a4a2a28d4551f597a81759269dd908c447ac433021b8714eb3ea4

See more details on using hashes here.

File details

Details for the file colory_pprint-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: colory_pprint-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for colory_pprint-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44f6b498ac9330a0c3d5b57d955f082440f63e6c591290d9afb20e0155c041cb
MD5 977b528f889de12f75de996579f7361a
BLAKE2b-256 4b473160c651806b119c0196a5a39cd2187771376ca946d2e6f2b37c86d2db22

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