Command-line help on Python modules, classes and functions
This package procures the command-line tool pyh. It works somewhat like UNIX's
man, but for Python's docstring-based help system. In a nutshell:
$ pyh print
print(...)
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file: a file-like object (stream); defaults to the current sys.stdout.
sep: string inserted between values, default a space.
end: string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.
A more complex example:
$ pyh pathlib Path.is_file
Help on function is_file in module pathlib:
is_file(self)
Whether this path is a regular file (also True for symlinks pointing
to regular files).
To shorten the command lines a bit, one can configure a set of their favorite aliases for modules names in file
$XDG_CONFIG_HOME/pyh/aliases (which typically resolves to $HOME/.config/pyh/aliases). The alias file is written in
the NestedText format, which looks similar to YAML. One simply encodes an
alias-to-module name dictionary, one line per entry. Example:
pd: pandas
pl: pathlib
ap: argparse
Metadata
Release files for helphelp 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| helphelp-2.0.1.tar.gz | 3.3 kB | Without provenance | Details for helphelp-2.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| helphelp-2.0.1-py3-none-any.whl | Python 3 | none | any | Details for helphelp-2.0.1-py3-none-any.whl |
Total release size: 6.6 kB
Release files / helphelp-2.0.1.tar.gz
| Download URL | helphelp-2.0.1.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb9bd3bf042ba7865bb2d22bbd2b14b6f4d52e5806faa1034e56461ba1f612f3
|
|
BLAKE2b-256 checksum How to use checksums |
54f71d1575d2ebb8b8c2f19c0de783188b72d906df6e7bd88e2b8bbf0e4f91fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/0.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200925 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5
|
Release files / helphelp-2.0.1-py3-none-any.whl
| Download URL | helphelp-2.0.1-py3-none-any.whl |
|---|---|
| Size | 3.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d50aa626843ea6e95e48356a1c794a481ff96abc65c5ecae85e8127e4671563
|
|
BLAKE2b-256 checksum How to use checksums |
4648b736a883d9213228db933ba554fc65ec0750c31e2e9f789bec18ad5830d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/0.0.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200925 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5
|
Security for helphelp 2.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.