Skip to main content

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

Project description

🎨 Fluxura - A Styler For Terminal Outputs 🖌️

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

Current Stage: v0.1.1-alpha0

GitHub License GitHub last commit PyPI - Downloads

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.

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))

For more examples, check test_fluxura.py in the tests folder.

🎨 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🔨


Banner Broothers Logo (White) Banner Broothers Logo (Black)

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.1a1.tar.gz (7.3 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.1a1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file fluxura-0.1.1a1.tar.gz.

File metadata

  • Download URL: fluxura-0.1.1a1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for fluxura-0.1.1a1.tar.gz
Algorithm Hash digest
SHA256 3b70c79cd27705e363313638c2869c07f52491a8e766938701c08faa8d5e51d7
MD5 8f832352e5d961e7735b940e937594e0
BLAKE2b-256 157c7f715d9babf55c1d51561257edbf23d7fc283bb7d486c7b2ad39b27656ee

See more details on using hashes here.

File details

Details for the file fluxura-0.1.1a1-py3-none-any.whl.

File metadata

  • Download URL: fluxura-0.1.1a1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for fluxura-0.1.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 870a3e92f7fd7153b450723253f4aab2e409e28f938c864cb6fc920064e35697
MD5 17fb066e8800aca2eb545d5de26067b4
BLAKE2b-256 5c4bb4a4af10f420c8a2f75e0e00aafec4f3ed2ff68a19dcd7fbd5e8c1c091cd

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