Skip to main content

Simple coloured logging for Flask and FastAPI apps

Project description

python-coloured-logger

A lightweight Python package that provides clean, coloured logging output for Flask, FastAPI, and any standard Python application.

It extends Python’s built-in logging module with readable coloured console output and simple setup helpers.


Features

  • Coloured console logging
  • Works with standard Python logging
  • Flask integration
  • FastAPI / Uvicorn integration
  • Simple setup API
  • Lightweight with minimal configuration

Installation

Install from PyPI:

pip install python-coloured-logger

Quick Start

from coloured_logger import get_logger

logger = get_logger("my-app")

logger.debug("Debug message")
logger.info("Server started")
logger.success("Database connected")
logger.warning("High memory usage")
logger.error("Request failed")
logger.critical("System crash")

Example output:

[2026-05-27 12:00:00] INFO     Server started
[2026-05-27 12:00:01] SUCCESS  Database connected
[2026-05-27 12:00:02] WARNING  High memory usage
[2026-05-27 12:00:03] ERROR    Request failed

Flask Integration

from flask import Flask
from coloured_logger import setup_logging

app = Flask(__name__)

setup_logging(logger_name="flask.app")

@app.route("/")
def index():
    app.logger.info("Request received")
    return "Hello World"

FastAPI Integration

from fastapi import FastAPI
from coloured_logger import setup_logging

app = FastAPI()

setup_logging(logger_name="uvicorn")

@app.get("/")
async def root():
    return {"message": "Hello World"}

Standard Python Logging

from coloured_logger import setup_logging
import logging

setup_logging()

logger = logging.getLogger("example")

logger.info("Using standard logging")

Environment Variables

Enable or Disable Colours

By default, colours are enabled.

COLOURED_LOGGER_COLOR=True

or for Flask-specific configuration:

FLASK_LOG_COLOR=True

Disable colours:

COLOURED_LOGGER_COLOR=False

Custom Date Format

COLOURED_LOGGER_DATE_FORMAT=%Y-%m-%d %H:%M:%S

or:

FLASK_LOG_DATE_FORMAT=%H:%M:%S

Supported Log Levels

Level Description
debug Debug information
info General information
success Successful operations
warning Warning messages
error Error messages
critical Critical failures

Requirements

  • Python 3.9+
  • Flask (optional)
  • FastAPI / Uvicorn (optional)

License

MIT License


Contributing

Pull requests, issues, and suggestions are welcome.

If you find a bug or want to improve the package, feel free to open an issue or submit a PR.


Links

  • PyPI: https://pypi.org/project/python-coloured-logger/
  • GitHub: https://github.com/Skulldorom/python-coloured-logger

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

python_coloured_logger-0.1.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

python_coloured_logger-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file python_coloured_logger-0.1.1.tar.gz.

File metadata

  • Download URL: python_coloured_logger-0.1.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for python_coloured_logger-0.1.1.tar.gz
Algorithm Hash digest
SHA256 85db43ed87ae2cb70ad3ee911992ebc070ef5d071e01bb1a20b8ef6fd92dee04
MD5 791a1972647f4ebf50c65447cb17fdb3
BLAKE2b-256 3e2729afd8d79329332361e49200bb9a0804bb4da44071e91bab048f7571802c

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_coloured_logger-0.1.1.tar.gz:

Publisher: publish.yml on Skulldorom/coloured-logger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_coloured_logger-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_coloured_logger-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b61258034e6ecb02e131d937bd118265e3027df8ae3eabbc6ab0189b7917db90
MD5 be43fca66bccabfdb56d5dc0b280ab27
BLAKE2b-256 fcfcfc622a09edb26255b20d86d97962ab9304e9a4890315cf25a0211d079a30

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_coloured_logger-0.1.1-py3-none-any.whl:

Publisher: publish.yml on Skulldorom/coloured-logger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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