Skip to main content

A customizable terminal UI toolkit with beautiful banners and colored logging

Project description

ToolsCord

A customizable terminal UI library with a centered banner and advanced logging features. ToolsCord provides colorful, styled terminal output with different log types, custom styling, and formatting options.

Features

  • Customizable ASCII art banner display with any text
  • Personal logger style with "{time} • {type} > message" format
  • Various log types with appropriate styling: info, success, warning, error, debug, etc.
  • Rich color palette with 70+ colors including basic ANSI, bright variants, and brand colors
  • Text styling with bold, italic, underline, and more
  • Advanced text coloring with rainbow and gradient effects
  • Customizable bullet styles between time and type
  • Timestamps on log messages
  • Divider lines

Installation

You can install ToolsCord directly from PyPI:

pip install toolscord

Usage

Basic Usage

from toolscord import Logger, display_banner, ToolsCordColors

# Display the default "TOOLS CORD" banner
display_banner()

# Create a logger instance
logger = Logger()

# Use different log types
logger.info("This is an information message")
logger.success("Operation completed successfully")
logger.warning("This is a warning message")
logger.error("An error occurred")

Customizing the Banner

from toolscord import display_banner, ToolsCordColors

# Display the banner with custom text
display_banner("Hello World!")

# Display the banner with different base colors
display_banner("PYTHON", base_color=ToolsCordColors.TWITTERBLUE)

# Display the banner with both custom text and colors
display_banner("GITHUB", base_color=ToolsCordColors.GITHUB_PURPLE)

# Use the original TOOLSCORD banner (for backward compatibility)
from toolscord import display_toolscord_banner
display_toolscord_banner()

Colored Text

from toolscord import red, green, blue, bold, rainbow, gradient

# Simple color functions
print(red("This text is red"))
print(green("This text is green"))
print(bold("This text is bold"))

# Special effects
print(rainbow("This text has rainbow colors"))
print(gradient("This text has a gradient", (255,0,0), (0,0,255)))  # Red to blue gradient

# Direct printing functions
from toolscord import print_success, print_error, print_rainbow
print_success("Operation completed!")
print_error("Something went wrong")
print_rainbow("ToolsCord is awesome! github.com/bhaskarsaikia-17")

Customizing the Output

# Create a logger without timestamps
logger = Logger(show_time=False)

# Use formatting options
logger.log("Bold text", bold=True)
logger.log("Underlined text", underline=True)
logger.log("Custom color", color=ToolsCordColors.PINK)
logger.log("Twitter Blue color", color=ToolsCordColors.TWITTERBLUE)

# Print a divider
logger.divider("=", 60, ToolsCordColors.CYAN)

Logger Usage

from toolscord import Logger, ToolsCordColors

# Create a logger with default settings
logger = Logger()

# Basic log types
logger.info("This is an information message")     # {time} • INFO > This is an information message
logger.warning("This is a warning message")       # {time} • WARN > This is a warning message
logger.error("An error occurred")                 # {time} • ERROR > An error occurred
logger.success("Operation completed")             # {time} • SUCCESS > Operation completed

# Custom bullet style
logger = Logger(bullet_style="→")
logger.info("Using arrow bullet style")           # {time} → INFO > Using arrow bullet style

# Try other bullet styles
logger = Logger(bullet_style="⌁")                 # Zigzag
logger = Logger(bullet_style="⨠")                 # Square donut
logger = Logger(bullet_style="‣")                 # Triangle 
logger = Logger(bullet_style="⁕")                 # Flower
logger = Logger(bullet_style="⁙")                 # Dot pattern

# Without timestamp
logger = Logger(show_time=False)
logger.info("No timestamp shown")                 # INFO > No timestamp shown

Available Colors

ToolsCord provides a comprehensive range of colors:

from toolscord import ToolsCordColors

# Basic colors
ToolsCordColors.BLACK
ToolsCordColors.RED
ToolsCordColors.GREEN
ToolsCordColors.YELLOW
ToolsCordColors.BLUE
ToolsCordColors.MAGENTA
ToolsCordColors.CYAN
ToolsCordColors.WHITE

# Bright colors
ToolsCordColors.BRIGHT_RED
ToolsCordColors.BRIGHT_GREEN
# ... and more

# Brand colors
ToolsCordColors.GITHUB_PURPLE
ToolsCordColors.TWITTERBLUE
ToolsCordColors.DISCORD_BLURPLE
ToolsCordColors.SPOTIFY_GREEN
# ... and more

# Special colors
ToolsCordColors.ORANGE
ToolsCordColors.TEAL
ToolsCordColors.GOLD
# ... and more

Example

See example.py and color_demo.py for a complete demonstration of ToolsCord's features.

Requirements

  • Python 3.6+

License

MIT

GitHub

https://github.com/bhaskarsaikia-17/toolscord

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

toolscord-0.3.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

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

toolscord-0.3.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file toolscord-0.3.0.tar.gz.

File metadata

  • Download URL: toolscord-0.3.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.1.2 readme-renderer/44.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.7 tqdm/4.66.1 importlib-metadata/8.7.0 keyring/25.6.0 rfc3986/1.5.0 colorama/0.4.6 CPython/3.11.6

File hashes

Hashes for toolscord-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3591aa81347ea3a34104948e22751c72c5ea8f20403d10db9599c8618b613f44
MD5 232c5f33b8f4018c257dc8015c1c8843
BLAKE2b-256 94d32e036031a72a9c528d03d823d8324ad55bf6c2f3fa6e83d9e71daba58c59

See more details on using hashes here.

File details

Details for the file toolscord-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: toolscord-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.12.1.2 readme-renderer/44.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.7 tqdm/4.66.1 importlib-metadata/8.7.0 keyring/25.6.0 rfc3986/1.5.0 colorama/0.4.6 CPython/3.11.6

File hashes

Hashes for toolscord-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b51bb4402296eabcbc29f16d065c8637d7a53882567cf022433c8d75b10ab46
MD5 924c15ec831f10f6980068f737835d1f
BLAKE2b-256 df9850b848889891d24d806f467468b579b92c1a37f0ac80578a1ee213708d18

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