Metadata-Version: 2.1
Name: superhelp
Version: 0.0.8
Summary: SuperHELP - Help for Humans!
Home-page: https://git.nzoss.org.nz/pyGrant/superhelp
Author: Grant Paton-Simpson
Author-email: grant@p-s.co.nz
License: MIT
Download-URL: https://git.nzoss.org.nz/pyGrant/superhelp/dist/superhelp-0.0.8.tar.gz
Description: # https://git.nzoss.org.nz/pyGrant/superhelp
        
        version number: 0.0.8
        author: Grant Paton-Simpson
        
        ## Overview
        
        Superhelp is Help for Humans! The goal is to provide customised help for simple
        code snippets. Superhelp is not intended to replace the built-in Python help but
        to supplement it for basic Python code structures. Superhelp will also be
        opinionated. Help can be provided in a variety of contexts including the
        terminal and web browsers (perhaps as part of on-line tutorials).
        
        ## Quick Start
        
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgit.nzoss.org.nz%2FpyGrant%2Fsuperhelp.git/master?filepath=notebooks%2FSuperhelpDemo.ipynb)
        
        ## Installation
        
        To install
        
        1) Use pip e.g.
        
            $ pip3 install superhelp
        
        or similar
        
            $ python3 -m pip install superhelp
        
        2) Or clone the repo
        
            $ git clone https://git.nzoss.org.nz/pyGrant/superhelp.git
            $ python3 setup.py install
        
        ## Example Use Cases
        
        * Charlotte is a Python beginner and wants to get advice on a five-line function
        she wrote to display greetings to a list of people. She learns about Python
        conventions for variable naming and better ways of combining strings.
        
        * Avi wants to get advice on a named tuple. He learns how to add doc strings to
        individual fields.
        
        * Zach is considering submitting some code to Stack Overflow but wants to
        improve it first (or possibly get ideas for a solution directly). He discovers
        that a list comprehension might work. He also becomes aware of dictionary
        comprehensions for the first time.
        
        * Noor has written a simple Python decorator but is wanting to see if there is
        anything which can be improved. She learns how to use functool.wrap from an
        example provided.
        
        * Al is an experienced Python developer but tends to forget things like doc
        strings in his functions. He learns a standard approach and starts using it more
        often.
        
        # Example Usage
        
        ## Notebook
        
        Add new cell at end with content like:
        
            show(superhelp("""\
            def sorted(my_list):
                sorted_list = my_list.sort()
                return sorted_list
            """))
        
        and run it to get advice.
        
        ## Local Installation
        
            $ shelp -h  ## get help on usage
        
            $ shelp --snippet "people = ['Tomas', 'Sal', 'Raj']" --displayer html --level Main
            $ shelp -s "people = ['Tomas', 'Sal', 'Raj']" -d html -l Main
        
            $ shelp --file-path my_snippet.py --displayer cli  --level Extra
            $ shelp -f snippet1.txt -d cli -l Brief
        
            $ shelp  ## to see advice on an example snippet displayed (level Extra)
        
            
        ## TODO Options
        
        1) Extend advice further to encourage sound practice
        
        2) Perhaps add style linting as an option
        
        3) Extend beyond standard library into popular libraries like requests, bottle,
        flask etc.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
