Skip to main content

Easy-to-use color coordination terminal library with simple customization & function binding.

Project description

Easy Mark (ezmk)

Easy-to-use color coordination terminal library with simple customization & function binding. image

Use now with pip install ezmk

mark(string, **kwargs)

Use the mark() as you would use the print() function but with the additional features of easy-to-add format modification.

Modify text color by prefixing your statement with ^, followed by an appropriate color specification.

Example mark("^red This text is red!")

Use the # key to specify the background color, and use the ~ key to specify styling such as bold, underline, or italic. Colors and styles autocomplete if identifying initial words are used like mark("#r This text is also red!").

You can add multiple modifiers if you indicate their end with a space like mark("#m^b~u working text!"). Using mark("#m ^b ~u failed text!") will only interpret the first modifier.

To print a simple and noticeable message to the console, fire the mark() function without arguments.

Text Foreground and Background Colors

black, red, green, yellow, blue, magenta, cyan, white, gray, light-red/lr, light-green/lg, light-yellow/ly, light-blue/lb, light-magenta/lm, light-cyan/lc, light-white/lw

Text Style Effects

bold/b, dim/d, italic/i, underline/u, blink/bl, reverse/r, hidden/r, strikethrough/r

bind(func, activation_string, args=(args), kwargs=(kwargs))

To pass a function and bind it to a custom key you can use bind(). When the key is used following the bind character: @ like mark("@bnd_fnc Binded function fired!") the function will be called.

To set a function to bind to the mark() function itself pass the function without a key.

Presets

You can specify presets in configuration, allowing you to use a key(activation string) to add a collection of modifiers to a statement. No space is needed to indicate a preset's ending unless the preset contents a space itself. This enables very handy color-coordinated printing to the console:

Example mark("!Alert preset.") or mark("$Success preset.") (using default presets.)

Configuration

To configure, create ezmk.cfg file in the project directory.

  • ping:string What's printed to the console when mark() when fired without any arguments.
  • debug:bool If set to true, print the raw interpretation of each mark statement to terminal.
  • presets:dict Custom keys that load configured format modifiers. Defaults include(to change default either override or list in blacklist):
    • ! as ~b^r#y
    • $ as ^lg#g
    • warn as ^y~b
    • test as ^m~i
    • main as ^blu#bla~u
  • blacklist Presets or modifiers that don't get interpreted.

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

ezmk-1.0.3.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

ezmk-1.0.3-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file ezmk-1.0.3.tar.gz.

File metadata

  • Download URL: ezmk-1.0.3.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for ezmk-1.0.3.tar.gz
Algorithm Hash digest
SHA256 fb01c94f9ee40a0dc117cf8a7349a062aaa1346f6f2df8e506bcb7918aa32d67
MD5 203af8836a6c6bace1e63a47edf647b9
BLAKE2b-256 9ac7cf023b52810cea84ab67c04535010464b6eed38d8ea627cf205b5fd53972

See more details on using hashes here.

File details

Details for the file ezmk-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: ezmk-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for ezmk-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 70b167b4beea9e10f34638aa95406d8fd45ee79fd4d99ae4e757b0a765029852
MD5 93460708642a7c7a69df5289fff0279e
BLAKE2b-256 5ad85d69a7e2080e9d48deeb703579783eccef8bce8b2a0359f9013a1051b790

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page