Metadata-Version: 2.1
Name: pythumbnail
Version: 0.0.3
Summary: A quick thumbnail creator for python codes
Home-page: https://github.com/kevinyang372/py-thumbnail
Author: Yunfan Yang
Author-email: yunfan.yang@minerva.kgi.edu
License: Apache2
Description: # Pythumbnail
        
        What is Pythumbnail?
        ---------------------
        
        Pythumbnail is a quick thumbnail creator for python codes. You can get an overview of the available functions, for/while loops and if conditions without even running the code.
        
        Suppose you have the following python file:
        
        ```python
        class someclass:
            def __init__(self):
                self.a = 10
        
            def do_something(self):
                for i in range(len(self.a)):
                    if i == 2:
                        print(i)
        
            def do_something_else(self, num):
                while self.a < 100:
                    self.a += num
        ```
        
        
        Here is a small example to show what Pythumbnail could do (Python 3):
        
        ```python
        import pythumbnail
        
        file = pythumbnail.read_file('some_file.py')
        file.scan()
        print(file.tree)
        ```
        
        The output will look like:
        
        ```python
        'File some_file.py()'
            'class someclass()'
                'def __init__(self)'
                'def do_something(self)'
                    'for i in range(len(self.a))'
                        'if[i,2] LOGIC: [==]'
                'def do_something_else(self,num)'
                    'while[self.a,100] LOGIC: [<]'
        ```
        
        Quick Start
        -----------
        
        To install Pythumbnail, you need python version 3.6.0 or above. Pythumbnail could be installed from pypi:
        
            $ python3 -m pip install pythumbnail
        
        Running Pythumbnail:
        
        ```python
        import pythumbnail
        ```
        
        Usage
        -----
        
        Read Documents (This step is necessary to initialize pythumbnail object)
        
        ```python
        import pythumbnail
        
        file = pythumbnail.read_file('some_file.py') # reads in a new python file
        file = pythumbnail.read_file('some_file.py', silence = False) # turns on logging mode (will output all state changes)
        file = pythumbnail.read_file('some_file.py', tab_to_space = 2) # customizes how many spaces is one tab equal to (default = 4)
        ```
        
        Scan The Document
        
        ```python
        file.scan()
        ```
        
        Output Thumbnail (Document needs to be scanned first)
        
        ```python
        print(file.tree)
        ```
        
        Show Summary (Document needs to be scanned first)
        
        ```python
        file.show_summary()
        ```
        
        Contributing
        ------------
        
        Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
        
        License
        -------
        
        [Apache License 2.0](http://www.apache.org/licenses/)
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
