Pytterns

One stop library for all your Terminal Patterns

With pytterns, you can make your projects pop with patterns and shapes. With this, you can print any pattern, with high customization, in any senario in the terminal. You can even make your custom Patterns through .py based pattern template system. This project has solid security and large compatibility with terminal sizes, color rendering, and OS. If you are working on a terminal project, need a loading page or you need to print shapes in any case, No need to learn each and every pattern. Just use Pytterns!

How it works

Pytterns has default patterns which can be used to get basic shapes with quite a lot of customization directly printed in the console.

You may also make your own pattern theme by making your own .py templates. Once added to Pytterns, you can use it in your code RIGHT AWAY!

Installation

To get started, you can use 2 options.

1. Download the files from git and integrate with your code.

OR

2. Download the library through pip. → Download Through PIP

Get started with Default Pytterns

Each Pyttern Pattern file which is made by me is heavily documented, so if you open it in the /patterns folder, you can get a good understanding of the args and how its processed.

Once installed, just use this to start using Pytterns in your code

from pytterns import Pytterns

pt = Pytterns()

Basic Default Args for Patterns

To make any supported shape, we use the following method to print it in the terminal:

pt.(, char=, center=, color= ...)
gt;, color=<color> ...)

For a simple square of side length 10:

pt.square(10)

Output:

* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
* * * * * * * * * *
 * * * *

Char

To make this same square with different characters, we can use the char arg.

Char takes in a String Input.

For Example, to make the above square with "x":

pt.square(10,char="x")

You get a square made with x

Center

With the center arg, we can center most of the shapes perfectly in the terminal.

Center takes a boolean input, True/False

For Example, to center the above square, we use:

pt.square(10, char="x", center=True)

Color

With the color arg, you can color your shapes with the following colors:

• red
• green
• blue
• yellow
• magenta
• cyan
• white
• reset

For example, you can color the above square like:

pt.square(10, char="x", center=True,color="red")

Hollow

With the hollow arg, you can make shapes hollow, and just get its border.

The hollow arg takes in a Boolean, True/False.

For Example, you can make a Red Centered hollow square of radius 10, made with $ like:

pt.square(10, char="$",center=True,color="red",hollow=True)

Output:

-$ $ $ $ $ $ $ $ $ $

-$                 $

-$                 $

-$                 $

-$                 $

-$                 $

-$                 $

-$                 $

-$                 $

-$ $ $ $ $ $ $ $ $ $

Terminal render would be proper and centered.

Filler

As you may have noticed in above output examples, each shape has a space (filler) between the characters. This is a space by default, but we can customize this through the filler arg.

For Example, for the above hollow square filled with Spaces, we can make it fill with - through:

pt.square(10, char="$",center=True,color="red",hollow=True, filler="-")

Output:

- $-$-$-$-$-$-$-$-$-$

- $-----------------$

- $-----------------$

- $-----------------$

- $-----------------$

- $-----------------$

- $-----------------$

- $-----------------$

- $-----------------$

- $-$-$-$-$-$-$-$-$-$

Terminal render would be proper and centered.

Other Important Args

For special shapes like Triangles or Pyramids, which could be flipped upside down, Direction and Invert can be used.

Direction:

Used to set pointing direction of a supported shape.

For Example, We can make a triangle point to 2 directions, Left and Right:

pt.triangle(10, char="*",hollow=True,filler="-",direction="left")

Output:

*-
*-*-
*- -*-
*- - -*-
*- - - -*-
*- - - - -*-
*- - - - - -*-
*- - - - - - -*-
*- - - - - - - -*-
*-*-*-*-*-*-*-*-*-*-
*-*-*-*-

Invert:

With this, we can make supported shapes Upside-Down. This can be used with direction arg to gain full control of the shape's pointing.

For example, to make a left triangle inverted we use:

pt.triangle(10, char="*",hollow=True,filler="-",direction="left",invert=True)

Output:

*-*-*-*-*-*-*-*-*-*-
*- - - - - - - -*-
*- - - - - - -*-
*- - - - - -*-
*- - - - -*-
*- - - -*-
*- - -*-
*- -*-
*-*-
*-
*-*-
*-

3D Shapes

CUBE

You can make a revolving or static CUBE in Pytterns, which is super cool. To do this, simply use the pt.cube() function. Use the following args for customization.

char [str]

Defines the character used for the creation of cube

size [int]

Defines the size of cube. This is NOT the number of characters in an edge of a cube. A sweet spot is 100, Cube would not be visible for size under 40

rotate [bool]

If enabled, the cube would show a rotating animation and show all of its sides.

rot_speed [int]

This is a really sensitive parameter, it defines the rotating speed of the cube. 5 is a sweet spot

Duration [int]

This is the amount of seconds you want the cube to rotate for. Set to None to keep it forever in loop. (Only works when rotation is activated)

refresh_time [int]

This isnt usually to be messed with. It is the time after which the loop is re-run for the next frame. 0.03 is good as it gives about 33 FPS

angle [int]

Angle in radian for the cube to be displayed (if rotation off) or the cube to start rotating from (if rotation enabled)

colored [bool]

By default, the edges of cube are colored for full 3d effect. It can be set to default terminal color if this is set to False.

clr_screen [bool]

This isnt usually to be messed with. It defines if the new frame should be over written on the old frame or the screen should be completely cleared and re written for next frame.

Note: Cubes always remain centered because they need space to show the 3d effect and revolve.

---

Panels

Pytterns can also make Panels. To make a Panel or List, you can use the pt.panel() Function

Panels are extremely customizable. You can use the following arguments by default.

Size [int]

Horizontal Width of the Panel

Center [bool]

To horizontally center the panel in terminal

Title [str]

The Heading/Title of the panel

Content [list]

List of items to add to contents of panel

Padding [int]

Set minimum distance of text from borders

Customize Border Characters & Corners Charactersters

• v_border Vertical Line Characters

• h_border Horizontal Line Characters

• top_left Top Left Corner Merger Character

• top_right Top Right Corner Merger Character

• bottom_left Bottom Left Corner Merger Character

• bottom_right Bottom Right Corner Merger Character

border_bold [bool]

This makes the border characters bold, thick and bright.

center_content [bool]

This makes the content itself center within the panel's borders.

All Color args work same as they did in Shapes, and would work same in all types of patterns.

Examples for Panels.

pt.panel(
     size=80, 
     content=["Onion","Carrot","Pencils","RTX4090"],
     title="Shopping List",
     padding=2,
     border_bold=True,
     center_content=False,
     color="Magenta"

)

You may also use Colorama's editing in the content, to give each line its own color and style. The framework adapts accordingly.

Progress Bars

Now, you can make progress bars on pytterns too! Use the pt.progress() function. The following args can be used for customization.

size [int]

Defines the horizontal width of the progress bar. If its supposed to expand till the edges, use -1 or leave blank.

center [bool]

Centers the progress bar horizontally.

progress [int]

Defines the progress of the bar. If on a size 100, a progress of 50 is passed, the bar would show half filled.

fill [str]

Defines what character to fill in the shaded region of the loading bar

blank [str]

Defines what character to fill in the blank region of the loading bar

fill_color [str]

Defines the color of filled/shaded region

blank_color [str]

Defines the color of the blank region

Note: You should be using 1 char for the fill and blank arg. If you are using 2 or more char, divide the size with the same number to keep the size accurate.

Security Bypass

The program has built in security for preventing malicious script runs. If the security is breaking your custom themes, and you are confident that its safe, you can use this to load pytterns without security.

from pytterns import Pytterns

pt=Pytterns(break_my_system_security_and_allow_destruction=True)

Custom Templates

Through templates, you can make custom patterns based on our own code, and seamlessly use it just like you did with the default code.

This may sound difficult, but you don't even need a bit of advanced programming for this.

Getting Started:

Firstly ensure Pytterns is installed in your project. Then make a folder /patterns in your project's root directory.

You can create files in this folder now, and through this you can add custom patterns to your projects.

Once you make a .py file, start with the draw() function and define the args you need for the pattern you are trying to make. Size and Center is always must to keep, rest args are based on your wish.

For Example, this is the function definition for Triangles.

def draw(size,center, char="*", filler=" ", hollow=False, direction="left", invert=False):

In this, Size (int) is the shape's size, and Center is a boolean telling if trigger has opted for centering or not.

⭐Note: If you wish to use centering in your code, you need not to make any centering system in your template file. Just make sure its compatible with our centering and you are good to go. Similarly, you also do not need to worry about colors, those get added automatically too!

After this, you can just make your pattern function, and print the output in that function itself and the Pytterns takes care of everything!

Advanced Use

With pytterns, you can also make terminal animations/loading-graphics.

Eg. 1

For Example, if you want fast upward moving arrows, use this:

import time

colors=["red", "green", "yellow", "blue", "magenta", "cyan"]


while True:
     for i in range(0, 6):
         pt.triangle(i, char="-", color=colors[i], hollow=False, center=True)
         time.sleep(0.05)
    

Output:

*It would be animated due to loop, demo videos in /images folder

Eg. 2

Or, For Example you can use my favorite, the Square Loading:

import time,os

colors=["red", "green", "yellow", "blue", "magenta", "cyan"]

while True:
     for i in range(0, 6):
         pt.square(i, char="-", color=colors[i], hollow=False, center=True)
         time.sleep(0.05)
         os.system("cls" if os.name == "nt" else "clear")

For this you would need to see the video at /images folder

Eg. 3

You can use this to make a fun dynamic display of text through Panels.

import time, os

from colorama import Fore, Style


from pytterns import Pytterns

pt = Pytterns()


os.system('cls' if os.name == 'nt' else 'clear')

print("\033[?25l", end="") 


logs = [
     f"{Fore.CYAN}My code is hungry... it hasn't seen a 'Star' in weeks.",
     f"{Fore.RED}If you use 1960s Print() statements, {Style.BRIGHT}Users CRY.",
     f"{Fore.GREEN}I spent {Style.BRIGHT}3 business days {Style.NORMAL}fixing this right border.",
     f"{Fore.YELLOW}My family thinks I'm {Style.BRIGHT}studying.{Style.NORMAL} I'm actually just making {Style.BRIGHT}boxes centered.{Style.NORMAL}",
     f"{Fore.LIGHTBLUE_EX}Please use Pytterns or I'll be forced to use Light Mode.",
     f"{Fore.MAGENTA}Status: Desperately seeking validation (and a snack).",
     f"{Fore.MAGENTA}and Maybe a Break.. idk."

]


try:
     for i in range(1, len(logs) + 1):
         if i ==len(logs):
             time.sleep(4)
         print("\033[H", end="") 
         pt.panel(size=80, content=logs[:i], title="DEV-DESPERATION",padding=2,
                 border_bold=True, center_content=False,color="Magenta"
         )
         time.sleep(3)
     print(f"\n{Fore.WHITE}{Style.BRIGHT}   >> Hehe hope this was fun :)"un :)")

finally:
     print("\033[?25h")

Video in /images for the output

Contribution

This project is all open for your contributions! You can make more patterns for the default installation, and fix common rendering bugs. Lets together make the best python patterns library in the world!!

License

MIT