Metadata-Version: 2.1
Name: termshape
Version: 1.1.0
Summary: Tremshape is a minimalistic Python packgage, that only prints basic shapes on terminal.
Home-page: https://github.com/zvibazak/termshape
Author: Zvi Bazak
Author-email: zvibazak@gmail.com
License: MIT
Download-URL: https://github.com/zvibazak/termshape/archive/v_0.0.2.tar.gz
Description: [![PyPI version fury.io](https://badge.fury.io/py/termshape.svg)](https://pypi.org/project/termshape/)
        [![codecov](https://codecov.io/gh/zvibazak/termshape/branch/main/graph/badge.svg?token=PD5B5XX108)](undefined)
        ![Tests](https://github.com/zvibazak/termshape/workflows/Python%20application/badge.svg)
        
        # termshape
        Termshape is a minimalistic Python package, that only prints basic 
        shapes on terminal. 
        It does not have any dependencies.
        
        You're welcome to add any shapes!
        
        ## Installation 
        
        ```
        pip install termshape
        ```
        
        ### Explain:
        The ```get_*``` functions has (x,y) ranges, and some equations and print the lines.
        
        ### Example:
        ```python
        from termshape import get_square
        print(get_square(5, 5))
        ```
        so: 
        `x-range` is between 0 and 4
        `y-range` is between 0 and 4
        and the equations are:
        `x=0`, `y=0`, `x=5` and `y=5`.
        
        See below the output.
        
        ## Usage
        
        * Print a square:
        ```python
        from termshape import get_square
        print(get_square(5))
        ```
        ```
        * * * * *
        *       *
        *       *
        *       *
        * * * * *
        ```
        
        * Print a rectangle:
        ```python
        from termshape import get_rectangle 
        print(get_rectangle(10, 5))
        ```
        ```
        * * * * * * * * * *
        *                 *
        *                 *
        *                 *
        * * * * * * * * * *
        ```
        
        * Print a circle:
        ```python
        from termshape import get_circle
        print(get_circle(10))
        ```
        ```
                          * * * * *                
                      *               *            
                  *                       *        
                *                           *      
              *                               *    
                                                   
            *                                   *  
                                                   
          *                                       *
          *                                       *
          *                                       *
          *                                       *
          *                                       *
                                                   
            *                                   *  
                                                   
              *                               *    
                *                           *      
                  *                       *        
                      *               *            
                          * * * * *                
        ```
        
        * Print a triangle:
        ```python
        from termshape import get_triangular
        print(get_triangular(10))
        ```
        ```
        *                  
        * *                
        *   *              
        *     *            
        *       *          
        *         *        
        *           *      
        *             *    
        *               *  
        * * * * * * * * * *
        ```
        
        * Print a shape with custom character:
        ```python
        from termshape import get_rectangle
        print(get_rectangle(10, 5, fg='$'))
        ```
        ```
        $ $ $ $ $ $ $ $ $ $
        $                 $
        $                 $
        $                 $
        $ $ $ $ $ $ $ $ $ $
        ```
        
        * Print a shape with background:
        ```python
        from termshape import get_rectangle
        print(get_square(10, bg='.'))
        ```
        ```
        * * * * * * * * * *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * . . . . . . . . *
        * * * * * * * * * *
        ```
        
        * Print a shape with points:
        ```python
        from termshape import get_points
        points_array = [(0, 0), (0, 9), (9, 0), (9, 9)]
        print(get_points(10, 10, points_array, bg='.'))
        ```
        ```
        * . . . . . . . . *
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        . . . . . . . . . .
        * . . . . . . . . *
        ```
        
        * Print numbers:
        ```python
        from termshape import get_numbers
        print(get_numbers(31415926,3))
        ```
        ```
        * * * *          *    *     *          *    * * * *    * * * *    * * * *    * * * *
              *          *    *     *          *    *          *     *          *    *      
              *          *    *     *          *    *          *     *          *    *      
        * * * *          *    * * * *          *    * * * *    * * * *    * * * *    * * * *
              *          *          *          *          *          *    *          *     *
              *          *          *          *          *          *    *          *     *
        * * * *          *          *          *    * * * *    * * * *    * * * *    * * * *
        ```
Keywords: terminal,shape
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
