Skip to main content

Bring visual effect to your logging message.

Project description

Documentation Status https://github.com/MacHu-GWU/vislog-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/vislog-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/vislog.svg https://img.shields.io/pypi/l/vislog.svg https://img.shields.io/pypi/pyversions/vislog.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to vislog Documentation

https://vislog.readthedocs.io/en/latest/_static/vislog-logo.png

vislog is a ZERO-dependency logging library that brings visual effect to your logging message. It allows you to use any logging library you like, and just add visual effect.

@logger.emoji_block(msg="build", emoji="🏭")
def run_build():
    time.sleep(1)
    logger.info("run build")

@logger.emoji_block(msg="test", emoji="🧪")
def run_test():
    time.sleep(1)
    logger.info("run test")
    with logger.nested():
        run_build()

@logger.emoji_block(msg="deploy", emoji="🚀")
def run_deploy():
    time.sleep(1)
    logger.info("run deploy")
    with logger.nested():
        run_test()

run_deploy()

Will show:

[User 2024-06-16 15:06:44] +----- 🕑 🚀 Start 'deploy' -----------------------------------------------------+
[User 2024-06-16 15:06:44] 🚀
[User 2024-06-16 15:06:45] 🚀 run deploy
[User 2024-06-16 15:06:45] 🚀 +----- 🕑 🧪 Start 'test' -----------------------------------------------------+
[User 2024-06-16 15:06:45] 🚀 🧪
[User 2024-06-16 15:06:46] 🚀 🧪 run test
[User 2024-06-16 15:06:46] 🚀 🧪 +----- 🕑 🏭 Start 'build' --------------------------------------------------+
[User 2024-06-16 15:06:46] 🚀 🧪 🏭
[User 2024-06-16 15:06:47] 🚀 🧪 🏭 run build
[User 2024-06-16 15:06:47] 🚀 🧪 🏭
[User 2024-06-16 15:06:47] 🚀 🧪 +----- ⏰ ✅ 🏭 End 'build', elapsed = 1.01 sec ------------------------------+
[User 2024-06-16 15:06:47] 🚀 🧪
[User 2024-06-16 15:06:47] 🚀 +----- ⏰ ✅ 🧪 End 'test', elapsed = 2.02 sec ---------------------------------+
[User 2024-06-16 15:06:47] 🚀
[User 2024-06-16 15:06:47] +----- ⏰ ✅ 🚀 End 'deploy', elapsed = 3.03 sec ---------------------------------+

Install

vislog is released on PyPI, so all you need is to:

$ pip install vislog

To upgrade to latest version:

$ pip install --upgrade vislog

AI Agent Skill

vislog ships with a Claude Code agent skill that teaches AI assistants how to use this library. Copy the .claude/skills/vislog/ directory into your project’s .claude/skills/ (or ~/.claude/skills/ for global access), and the AI will know the full vislog API — no extra prompting needed.

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

vislog-0.1.3.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

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

vislog-0.1.3-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file vislog-0.1.3.tar.gz.

File metadata

  • Download URL: vislog-0.1.3.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vislog-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c164d85703d8cac5f297c21ec9b7db20d70aacded10550366fd3cf5ddd95b4a4
MD5 db6ef6340e514a208c5eefd5a1618b6c
BLAKE2b-256 a521ea82bd08939c4dd84655f2b6e3ff2a8a1c4773e03e06596c7effe96deac2

See more details on using hashes here.

File details

Details for the file vislog-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: vislog-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for vislog-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 faa40c8165d8c813b7c0dd9abd18d84d733bebe51e1c32910f2f490ad3f0357c
MD5 7fd81f67771ced5b5f487b1ff90c0bc9
BLAKE2b-256 a70bd2e5d6bc24abcf1520145601745fdfd7db17a8ffaac895f507ec448aecd0

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