Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/edraobdu/printy

Printy is lite and cross-platform library that extends the functionalities of the built-in functions print() and input()
https://github.com/edraobdu/printy

color-print inline-format library printy pypi python python3

Last synced: 1 day ago
JSON representation

Printy is lite and cross-platform library that extends the functionalities of the built-in functions print() and input()

Awesome Lists containing this project

README 

        
# Printy



![Travis (.org)](https://img.shields.io/travis/edraobdu/printy?logo=travis&style=flat-square) 

![Codecov](https://img.shields.io/codecov/c/gh/edraobdu/printy?logo=codecov&style=flat-square)

![PyPI](https://img.shields.io/pypi/v/printy?style=flat-square)

![PyPI - Wheel](https://img.shields.io/pypi/wheel/printy?style=flat-square)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/printy?logo=python&logoColor=blue&style=flat-square)

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)

![PyPI - License](https://img.shields.io/pypi/l/printy?style=flat-square)



Printy is a **light** and **cross-platform** library that extends the functionalities of the 

built-in functions ```print()``` and ```input()```. Printy stands out for its

simplicity and for being and easy to use library, it lets you colorize and apply some standard formats 

to your text with an intuitive and friendly API based on **flags**.



![Printy demo](.github/demo_printy.gif)



![Inputy Demo](.github/demo_inputy.gif)



_NOTE: Printy manages the most common and simple tasks when it comes to print 

text and to validate some input. If you want to have more control over the 

console output check out **[Rich](https://github.com/willmcgugan/rich)** by @willmcgugan, 

an amazing library that let's you do much more cool things!!_



## Table of Contents



1. [Installation](#installation)

2. [How to use it?](#how-to-use-it)

    1. [Using global flags](#using-global-flags)

    2. [Using inline flags](#using-inline-flags)

    3. [Untrusted sources](#untrusted-sources)

    4. [Background Colors](#background-colors)

3. [What about input()?](#what-about-input)

4. [Curious?](#curious)

5. [API](#api)

    1. [printy()](#printy)

    2. [inputy()](#inputy)

    3. [List 1: flags](#list-1-flags)

    4. [List 2: types](#list-2-types)

    5. [List 2: conditions](#list-3-conditions)

6. [Changelog](#changelog)

7. [Dependencies](#dependencies)

8. [Contributing](#contributing)

9. [Contributors](#contributors-)



## Installation



you can either clone this repository or install it via pip

```python

pip install printy

```



## How to use it?



Once you install printy, you can find a short but concise documentation about the

available flags and the syntax by running the following command on your console:

```python

python -m printy

```



This will print out some instructions right away.



![Printy Help me](.github/printy_helpme.png)

 

#### Using global flags



First of all, import printy:

```python

from printy import printy

```



Printy is still a 'print' statement, so you can use it as it is:

```python

printy("text with no format")

```



![Printy no format](.github/printy_no_format.png)



You can use a global set of flags to specify a format you want to apply to the text,

let's say we want to colorize a text with a bold blue and also adding an underline:

```python

printy("Text with a bold blue color and underlined", 'bBU')

```

![Printy global bold blue](.github/printy_global_bold_blue.png)



#### Using inline flags

Although applying a global format is interesting, it is not as much as applying

some specific format to some section of the text only. For that, printy uses a 

intuitive syntax to accomplish that goal. Use the [] to specify the flags to use

for formatting the text, right before the text, and the @ to finish the formatting 

section:

```python

printy("Predefined format [rI]This is red and with italic style@ also predefined format")

```

![Printy inline red italic](.github/printy_inline_red_italic.png)



The text that is not surrounded by the format syntax will remain with the predefined 

format.



But you can always override this predefined format for inline format specifying the flags 

in the 'predefined' parameter

```python

printy("Now this is blue [rI]Still red italic@ and also blue", predefined="b")

```

![printy changing predefined](.github/printy_changing_predefined.png)



Or, you can override the whole format without changing the inline format with a global flag:

```python

printy("Now i am still blue, [rI]and also me@, and me as well ", "b")

```

![Printy overriding inline with global](.github/printy_override_inline_with_global.png)



You can combine it with f-strings:

```python

a = 60

printy(f"The day has [yB]{ 24 * a }@ minutes")

```

![Printy f-strings](.github/printy_f_strings.png)



Printy also supports reading from a file, just pass the path to your file

in the file parameter:



```python

# NOTE: Here, it is necessary to specify the flags (if you want) 

# in the 'flags' parameter

printy(file="/path/to/your/file/file.extension", flags="cU")

```

![Printy from file](.github/printy_from_file.png)



You can also pretty print your dictionaries, lists, tuples, sets, and objects:



```python

my_dict = {'id': 71, 'zip_codes': ['050001', '050005', '050011', '050015', '050024'], 'code': '05001', 'country': {'code': 'co'}, 'city_translations': [{'language_code': 'es', 'name': 'Medellín'}], 'flag': None}

printy(my_dict)

```



![Printy pretty dict](.github/printy_pretty_dict_four_indentation.png)



```python

my_dict = {'id': 71, 'zip_codes': ['050001', '050005', '050011', '050015', '050024'], 'code': '05001', 'country': {'code': 'co'}, 'city_translations': [{'language_code': 'es', 'name': 'Medellín'}], 'flag': None}

printy(my_dict, indentation=2)

```



![Printy pretty dict](.github/printy_pretty_dict_two_indentation.png)



### New in v2.2.0



#### Untrusted sources



When dealing with untrusted sources, like, user input, we need to ensure the text is properly escaped

before we pass it to printy. For that, we can use the funtion `escape` integrated with printy.



Let's say we have and `email` variable that it's fill by an untrusted source:



```python

from printy import printy, escape



# Comes from an untrusted source

email = '[email protected]'



# Without escaping it

printy(f'This is your email: [nB]{email}@')



# Escaping it

printy(f'This is your email: [nB]{escape(email)}@')

```

![Printy escape](.github/escape_printy.png)



### New in v2.2.0



#### Background Colors



Now, we can define the background color of the text, either on inline formats or with global flags, we simply pass the color flag between two brackets:



```python

from printy import printy



# Global format

printy('Green bold text over a red background', 'nB{r}')



# Inline format

printy('Normal Text [nB{r}]Green bold text over a red background@ Also normal')

```



![Printy background](.github/background_printy.png)



## What about input()?



Printy also includes an alternative function for the builtin input(), that, not only

lets us applies formats to the prompted message (if passed), but also, we can force

the user to enter a certain type of data.

```python

from printy import inputy

```

Let's say we want to get an integer from the user's input, for that, we can set

type='int' in the 'inputy' function (we can specify formats the same way we'd do

 with printy)

```python

fruits = ["Apple", "Orange", "Pineapple"]

fruit = inputy("Select a fruit: ", options=fruits, condition="i")



qty = inputy("How many [yBU]%ss@ do you want?" % fruit, predefined="rB", type="int", condition="+")



confirmation = inputy("Are you sure you want [r]%d@ %ss?" % (qty, fruit), type="bool", options=["y", "n"], condition="i")

```



In all of the above examples, if the user enters a value with a type other than 

the one specified in 'type' (default is 'str'), the message will show again and will prompt also a warning 

(and so on until the user enters a valid value according to the type)



You can pass certain conditions to validate the input, for example, you can 

pass ```condition="+"``` on an input with type 'int' to force the user to enter

a positive integer (valid also for 'float'), check the complete options below



**The best part** is that the returned value's type is also the one of the specified 

type, therefore, from the above examples, both *fruit* will be str, *qty* will be integer, and

*confirmation* will be a boolean, so, you're gonna get the information right as you need it.



![Printy inputy Demo](.github/inputy_example.png)



### New in v2.1.0

You can also add some restriction for numbers: max_digits and max_decimals 



![Printy inputy max digits and max decimals](.github/inputy_max_digits_max_decimals.png)



## Curious?



If you want to know what's behind the scenes, you can get the text with all the ANSI escaped sequences,

for that, use the ```raw_format()``` function.



```python

from printy import raw_format

raw_text = raw_format("Some [rB]formatted@ [yIU]text@")

print(repr(raw_text))  

print(raw_text)

```



![Printy raw format](.github/printy_raw_format.png)



For convenience, we have stored all colors and formats flags in list, in case you need them:



```python

from printy import COLORS, FORMATS

print(COLORS)

print(FORMATS)

```



![Printy COLORS FORMATS](.github/printy_COLORS_FORMATS.png)



## API



### printy()



| Parameters | type |  | Description |

| --- | --- | --- | --- |

| value | str | required | Value to be formatted |

| flags | str | optional | Global flags to be applied, they can be passed in the 'value' with the following syntax: [flags]value@ (check [List 1](#list-1-flags) for more info)|

| predefined | str | optional | A set of flags to apply to the value as its predefined value |

| file | str | optional | A path to a file where we want to read the value from | 

| end | str | optional | A value to be appended to the value, default is '\n' |

| pretty | bool | optional | True if we want to pretty print objects, False if we do not (default True) |

| indentation | int | optional | Indentation when pretty printing dictionaries or any iterable (default 4) |



### inputy()

plus printy() parameters



| Parameters | type |  | Description |

| --- | --- | --- | --- |

| type | str | optional | Type of value we want the user to enter (check [List 2](#list-2-types) for more info)|

| options | list | optional | Valid only for types 'str' and 'bool', a list of options to scope the value |

| render_options | bool | optional | Specify whether we want to display the options to the user or not | 

| default | str | optional | If no value is entered, this one will be taken, make sure that it belongs to the options list (if passed) | 

| condition | str | optional | A character that applies certain restrictions to the value (check [List 3](#list-3-conditions) for mor info |

| max_digits | int | optional | Adds a restriction for numbers about the maximum number of digits that it should have |

| max_decimals | int | optional | Adds a restriction for numbers about the maximum number of decimals that it should have |



### List 1 'flags'



**COLORS**

- k - Applies a black color to the text

- g - Applies a grey color to the text

- w - Applies a white color to the text

-  - Applies a lightred color to the text

-  - Applies a lightgreen color to the text

-  - Applies a lightyellow color to the text

-  - Applies a lightblue color to the text

-  - Applies a lightmagenta color to the text

-  - Applies a lightcyan color to the text

-  - Applies a lightorange color to the text

- \
 - Applies a lightpurple color to the text



**FORMATS**

- B - Applies a bold font weight to the text

- U - Applies an underline to the text

- I - Applies an italic font type to the text

- H - Highlights the text

- S - Crosses out the text, aka Strike

- D - Dim effect



### List 2 'types'

- 'int': Value must be an integer or a string that can be turn into an integer, returns the value as an integer

- 'float': Value must be a float or a string that can be turn into a float, returns the value as a float

- 'bool': A string matching 'True' or 'False' if no options are passed, otherwise, a string that matches one of the options, returns the value as a boolean

- 'str': The default type, if 'options' is passed, then the string must match one of the options or its item number.



### List 3 'conditions'

- '+': Valid for 'int' and 'float' types only. The value must be a **positive** number

- '-': Valid for 'int' and 'float' types only. The value must be a **negative** number

- 'i': valid for 'str' and 'bool' types only. The value is case insensitive, by default it is case sensitive



## Changelog



[Changelog.md](CHANGELOG.md)



## Dependencies



Printy currently supports Python 3.5 and up. Printy is a cross-platform library



## Contributing



Please feel free to contact me if you want to be part of the project and contribute.

Fork or clone, push to your fork, make a pull request, let's make this a better app 

every day!!



## Contributors ✨



Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):





  

    
Edgardo Obregón
💻 ⚠️ 💡 🤔 🚧 📖 🐛

    
farahduk
🤔 💻 🚧

    
Mihir Singh
⚠️ 💻

    
musicprogram
📓

    
Tanmay
🤔

    
Oliver Bentham
📓

  



This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!