Release v0.1.3 (What’s new?).
Welcome to vislog Documentation¶
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.