SuperHELP - Help for Humans!
Project description
https://git.nzoss.org.nz/pyGrant/superhelp
version number: 0.0.3 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).
Installation
To install
-
Use pip e.g.
$ pip install superhelp
or similar
$ pip3 -m install superhelp
-
Or clone the repo
$ git clone https://git.nzoss.org.nz/pyGrant/superhelp.git $ python 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
$ 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
-
Extend advice further to encourage sound practice
-
Perhaps add style linting as an option
-
Extend beyond standard library into popular libraries like requests, bottle, flask etc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for superhelp-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 645f435141bf39034d2a6d7e173f69bef22118c36869a86281d5bf42750986d3 |
|
MD5 | 61dd80cba7b57dde994309fe77e01bfd |
|
BLAKE2b-256 | c69c3c011921f9430cdbd65974b09c4670bf1fb90fe8fa37d809e63c29e179d5 |