Skip to main content

A Python library for managing and accessing cute emoji symbols ๐Ÿ”ฅ

Project description

CuteSymbols ๐Ÿ”ฅ

A Python library for managing and accessing cute emoji symbols in your applications. Perfect for adding visual flair to your console output, logging, or user interfaces!

โœจ Features

  • ๐Ÿš€ Easy Access: Direct access to symbols using simple attribute syntax
  • ๐Ÿ” Smart Search: Powerful regex-based search with case-insensitive matching
  • ๐Ÿ“ Organized Categories: Symbols grouped by purpose (State, Activity, Emotion, Objects)
  • ๐Ÿ”„ Reverse Lookup: Find symbol names and groups from emoji values
  • ๐Ÿ“Š Complete Listing: List all available symbols with their metadata
  • ๐Ÿ› ๏ธ Developer Friendly: Full type hints and comprehensive documentation

๐ŸŽฏ Available Symbol Categories

State โœ…

  • CHECK โœ… - Success indicator
  • CROSS โŒ - Error indicator
  • WARNING โš ๏ธ - Warning indicator
  • INFO โ„น๏ธ - Information indicator
  • SUCCESS โœ”๏ธ - Success marker
  • FAILURE โœ–๏ธ - Failure marker
  • QUESTION โ“ - Question marker

Activity ๐Ÿš€

  • ROCKET ๐Ÿš€ - Launch/start indicator
  • LOOP ๐Ÿ”„ - Process/refresh indicator
  • CLOCK โฑ๏ธ - Timing indicator
  • HOURGLASS โณ - Loading indicator
  • FLASH โšก - Speed/power indicator

Emotion ๐Ÿ’ก

  • THINK ๐Ÿค” - Thinking indicator
  • BRAIN ๐Ÿง  - Intelligence indicator
  • LIGHT ๐Ÿ’ก - Idea indicator
  • FIRE ๐Ÿ”ฅ - Hot/trending indicator
  • MAGIC โœจ - Special indicator
  • STAR โญ - Favorite indicator
  • EYES ๐Ÿ‘€ - Attention indicator

Objects ๐Ÿ› ๏ธ

  • FOLDER ๐Ÿ“ - Directory indicator
  • GEAR โš™๏ธ - Settings indicator
  • TOOL ๐Ÿ› ๏ธ - Tool/utility indicator
  • BUG ๐Ÿž - Bug/issue indicator

๐Ÿ“š Quick Start

from cuteSymbols import CuteSymbols
# Create an instance
symbols = CuteSymbols()
# Access symbols directly
print(f"Task completed {symbols.CHECK}") # Task completed โœ… print(f"Loading {symbols.HOURGLASS}") # Loading โณ print(f"Great idea {symbols.LIGHT}") # Great idea ๐Ÿ’ก

๐Ÿ”ง Core Methods

Direct Symbol Access (Case-Insensitive) ๐ŸŽฏ

fire_emoji = symbols.FIRE # ๐Ÿ”ฅ fire_emoji = symbols.fire # ๐Ÿ”ฅ fire_emoji = symbols.Fire # ๐Ÿ”ฅ fire_emoji = symbols.fIrE # ๐Ÿ”ฅ
check_emoji = symbols.CHECK # โœ… check_emoji = symbols.check # โœ… check_emoji = symbols.Check # โœ…
rocket_emoji = symbols.ROCKET # ๐Ÿš€ rocket_emoji = symbols.rocket # ๐Ÿš€
# Use in your applications with any case style you prefer
print(f"Deployment started {symbols.rocket}") # ๐Ÿš€ print(f"Tests passed {symbols.SUCCESS}") # โœ”๏ธ print(f"Found issue {symbols.bug}") # ๐Ÿž

Search Functionality ๐Ÿ”

The search() method provides powerful pattern matching:

# Simple text search (case-insensitive by default)
results = CuteSymbols.search("fire")
# Returns: [('Emotion', 'FIRE', '๐Ÿ”ฅ')]
# Search by emoji
results = CuteSymbols.search("๐Ÿ”ฅ")
# Returns: [('Emotion', 'FIRE', '๐Ÿ”ฅ')]
# Regex patterns
results = CuteSymbols.search(r"^F") # Symbols starting with 'F'
# Returns: [('Emotion', 'FIRE', '๐Ÿ”ฅ'), ('State', 'FAILURE', 'โœ–๏ธ'), ('Objects', 'FOLDER', '๐Ÿ“')]
# Advanced regex with custom flags
import re results = CuteSymbols.search(r"fire", flags=0) # Case-sensitive results = CuteSymbols.search(r"f.*e$", flags=re.MULTILINE) # Multi-line pattern

Reverse Lookup ๐Ÿ”„

Find information about emojis:

# Get complete info (name and group)
info = CuteSymbols.info_from_emoji("๐Ÿ”ฅ")
# Returns: ('FIRE', 'Emotion')
# Get just the name
name = CuteSymbols.name_from_emoji("โœ…")
# Returns: 'CHECK'
# Handle unknown emojis
info = CuteSymbols.info_from_emoji("๐ŸŒŸ")
# Returns: None

List All Symbols ๐Ÿ“‹

# Get all symbols as tuples (group, name, value)
all_symbols = CuteSymbols.list_all()
# Returns: [('State', 'CHECK', 'โœ…'), ('State', 'CROSS', 'โŒ'), ...]
# Print a formatted table
CuteSymbols.print_table()

๐ŸŽจ Usage Examples

Console Logging

from cuteSymbols import CuteSymbols
symbols = CuteSymbols()
def log_status(message, status): if status == "success": print(f"{symbols.CHECK} {message}") elif status == "error": print(f"{symbols.CROSS} {message}") elif status == "warning": print(f"{symbols.WARNING} {message}") else: print(f"{symbols.INFO} {message}")
# Usage
log_status("Database connected", "success") # โœ… Database connected log_status("Connection timeout", "error") # โŒ Connection timeout log_status("Memory usage high", "warning") # โš ๏ธ Memory usage high

Progress Indicators

import time from cuteSymbols import CuteSymbols
symbols = CuteSymbols()
def show_progress(task_name): print(f"{symbols.HOURGLASS} Starting {task_name}...") time.sleep(1) print(f"{symbols.LOOP} Processing {task_name}...") time.sleep(1) print(f"{symbols.FLASH} Finalizing {task_name}...") time.sleep(1) print(f"{symbols.CHECK} {task_name} completed!")
show_progress("Data Analysis")

Dynamic Symbol Discovery

# Find all symbols containing "tool"
tools = CuteSymbols.search("tool") for group, name, emoji in tools: print(f"{emoji} {name} (from {group})")
# Find all fire-related symbols
fire_symbols = CuteSymbols.search("fire") print(f"Fire symbols: {[emoji for _, _, emoji in fire_symbols]}")
# Search by pattern
question_symbols = CuteSymbols.search(r".*TION") # Ends with "TION"

๐Ÿง  Advanced Features

Custom Search Flags

import re
# Case-sensitive search
results = CuteSymbols.search("Fire", flags=0) # Won't find "FIRE"
# Multi-line patterns
results = CuteSymbols.search(r"^FIRE$", flags=re.MULTILINE)
# Combine multiple flags
results = CuteSymbols.search(r"pattern", flags=re.MULTILINE | re.DOTALL)

Integration with Other Libraries

# With logging
import logging from cuteSymbols import CuteSymbols
symbols = CuteSymbols()
# Custom formatter
class EmojiFormatter(logging.Formatter): def format(self, record): if record.levelno == logging.ERROR: record.msg = f"{symbols.CROSS} {record.msg}" elif record.levelno == logging.WARNING: record.msg = f"{symbols.WARNING} {record.msg}" elif record.levelno == logging.INFO: record.msg = f"{symbols.INFO} {record.msg}" return super().format(record)

๐Ÿ” Error Handling

# Handle search errors
try: results = CuteSymbols.search("[invalid regex") except ValueError as e: print(f"{symbols.CROSS} Search error: {e}")
# Handle missing symbols
try: info = CuteSymbols.info_from_emoji(None) except AttributeError as e: print(f"{symbols.WARNING} {e}")

๐Ÿš€ Installation

# Clone the repository
git clone [https://github.com/yourusername/cutesymbols.git](https://github.com/yourusername/cutesymbols.git) cd cutesymbols

# Run tests
python -m unittest tests/tests.py -v

๐Ÿ“– API Reference

Methods

  • search(pattern, flags=re.IGNORECASE) - Search symbols by pattern
  • info_from_emoji(emoji) - Get name and group from emoji
  • name_from_emoji(emoji) - Get symbol name from emoji
  • list_all() - Get all symbols as tuples
  • print_table() - Print formatted symbol table

Properties

Access any symbol directly: symbols.FIRE, symbols.CHECK, etc.

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

๐Ÿ“„ License

This project is licensed under the MIT License.


Made with ๐Ÿ’ก and ๐Ÿ”ฅ by the CuteSymbols team!

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

cute_symbols-1.0.1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

cute_symbols-1.0.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file cute_symbols-1.0.1.tar.gz.

File metadata

  • Download URL: cute_symbols-1.0.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for cute_symbols-1.0.1.tar.gz
Algorithm Hash digest
SHA256 357cf818a45a36318d4539778149fca6a3c54d3d98297140bfb02fff9030a9a7
MD5 9c66e38a8a627b61708ccf20cb5480fd
BLAKE2b-256 170bf8bbbdb43e0a25f72f15b3bd4b86fc0d6d1ac7bdefb2629f01138864bb9f

See more details on using hashes here.

File details

Details for the file cute_symbols-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: cute_symbols-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for cute_symbols-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31936936d9a44af16dbf668aecc648ef54b7413664f6186f0d320a179862e032
MD5 0e05a2140d7740329ed75a04c64d3a0d
BLAKE2b-256 1d3e8c191a727ccaa886938bb06f85c0fe264cbce78962720f76caa9694e4c6c

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