Skip to main content

A soon-to-be easy way to style outputs in terminal

Project description

🎨 Fluxura 🖌️

⚠️FLUXURA IS IN THE ALPHA STAGE OF DEVELOPMENT, EXPECT BUGS⚠️

Fluxura is a Python library that provides terminal styling and coloring options for enhancing the appearance of command-line applications. With support for text styles like bold, italic, underline, and strikethrough, as well as foreground and background colors (including custom RGB colors), Fluxura gives the power to customize the look of terminal output with ease.

🔦Features

  • Text Styles: Apply styles like BOLD, ITALIC, DIM, UNDERLINE, and STRIKETHROUGH to terminal text.
  • Colors: Choose from predefined color options for foreground and background text colors.
  • Custom RGB Colors: Set custom RGB background colors for a more personalized look.
  • Gradient (hoping to develop): Apply gradients to text using two colors.
  • Simple API: Easy-to-use functions for styling and coloring text in the terminal.

📦Installation

You can install Fluxura using pip from PyPI (or TestPyPI for testing purposes).

From PyPI:

pip install fluxura

4. Example Usage:

Once installed, you can start using Fluxura to style terminal text.

```python
from fluxura import Color, Style, flux

# Example 1: Apply bold and red color to text
print(flux("Hello, World!", Style.BOLD, Color.fore.RED))

# Example 2: Apply italic and blue color to text
print(flux("This is a test!",  Style.ITALIC, Color.fore.BLUE))

# Example 3: Use a custom RGB background color
print(flux("Custom background colour!",  Style.ITALIC, Color.Back.CUSTOM(255, 165, 0))

# Example 4: Combine multiple styles and colors
print(flux("Bold, underlined, and green text",  Style.BOLD, Style.UNDERLINE, Color.Fore.GREEN)

🎨Customization

Fluxura can customize the foreground and background colors using built-in colors or by specifying RGB values. It can also customise the styles of the text in multiple ways.

  • Colours
    • Predefined colors:
      • Classic Variants: BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE.
      • Light Variants: LIGHT_BLACK, LIGHT_RED, LIGHT_GREEN, LIGHT_YELLOW, LIGHT_BLUE, LIGHT_MAGENTA, LIGHT_CYAN, LIGHT_WHITE.
    • To use a custom RGB color, pass the RGB values to the Color.____.custom() method like this:
      Color.Fore.CUSTOM(255, 165, 0)  # RGB values for orange foreground
      Color.Back.CUSTOM(255, 165, 0)  # RGB values for orange backgroun
      
  • Styles
    • Style Variants: BOLD, BRIGHT, DIM, ITALIC, STRIKETHROUGH

🔨MANY MORE FEATURES ARE EXPECTED TO COME SOON🔨

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

fluxura-0.1.0a0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

fluxura-0.1.0a0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file fluxura-0.1.0a0.tar.gz.

File metadata

  • Download URL: fluxura-0.1.0a0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for fluxura-0.1.0a0.tar.gz
Algorithm Hash digest
SHA256 588f211a468acdfdae4d0d0dd7d729d3319d9fb4489674ad6330332e59838b3c
MD5 bb33c324d15eee003fb49f9a5279fc0e
BLAKE2b-256 0bc221fd08d6c5a0f639a365970ce1aa022e4be44340fe21fdf2be9fb19b49dc

See more details on using hashes here.

File details

Details for the file fluxura-0.1.0a0-py3-none-any.whl.

File metadata

  • Download URL: fluxura-0.1.0a0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for fluxura-0.1.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 565517b5c4948299f42b3a88a72e58f2af8896c8d390ba896c959f2f56123bd8
MD5 911649defec80570ab39d7aa695cd0ac
BLAKE2b-256 16f245a474b0b354830cd121209f02c1aa348691914814a46e221e8b0421522b

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