Metadata-Version: 2.1
Name: visualist
Version: 0.2.4
Summary: A simple library to visualize lists.
Home-page: https://github.com/ThiNepo/visualist
Author: Thiago Nepomuceno
Author-email: thi.nepo@gmail.com
License: UNKNOWN
Description: # Visualist
        
        This is a very simple library to visualize lists in Python. 
        
        It was created mainly to support the creation of tutorials for [Neps Academy](https://neps.academy/) (amazing website :D).
        
        ### Install
        
        ```
        pip install visualist
        ```
        
        ### Usage
        
        The minimal example is shown below. It supposes that we want to create an image from the list [1, 2, -4, 2, -2, 5] and highlight the indexes [2, 4].
        
        ```python
        from visualist import Visualist
        
        visualist = Visualist()
        
        img = visualist.img_from_list([1, 2, -4, 2, -2, 5], [2, 4])
        img.show()
        ```
        
        The result of this code would be
        
        ![example](https://neps.academy/image/377.png)
        
        If you want to save the image change `img.show()` to `img.save('my_dear_list.png')`.
        
        If you use the method `img_from_lists` it will work with a list of lists. Note that the _highlights_ also need to be a list of lists. 
        
        ```python
        from visualist import Visualist
        
        visualist = Visualist()
        
        img = visualist.img_from_lists([[1, 2, -4, 2, -2, 5], [1, 2, 3, 4]], [[2, 4], [1]])
        img.show()
        ```
        
        The result will be
        
        ![example](https://neps.academy/image/376.png)
        
        #### Building the library
        
        To build the library you need the **wheel** module:
        
        ```
        pip install wheel
        ```
        
        and run the following command:
        
        ```
        python setup.py sdist bdist_wheel
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
