Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python help CLI

Project description

hlp

Get Python help from the command-line.

terminalcast

Setup

pip install hlp

To enable autocompletion, put the following in your shell's init script:

eval "$(hlp --autocomplete-init=bash)"

Usage

hlp part [parts ...]

Where part and parts combined form a Python package, module, or class name. When executed, hlp runs the help() built-in function on the combined parts.

For example:

hlp http
hlp http.server
hlp http server
hlp http server SimpleHTTPRequestHandler

hlp autocompletes package, module, and class names.

hlp provides help for the Python environment it is executed under. To get help for a different environment, install help into it. Only one user-level install is supported. If more are required, it may be better to just use path/to/python -m pydoc.

Features

  • Module and class name autocompletion (in bash)
  • A few less characters than python -m pydoc

Development

Tests/Linters

Install nox and run it in the root of the repository.

Release

  1. Identify commit to promote artifacts for, it must have a successful build with artifacts pushed to S3.
  2. Locally tag commit with annotated tag.
  3. Push tag to repo.
  4. Create PR to bump version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hlp, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size hlp-0.2.1-py2.py3-none-any.whl (7.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size hlp-0.2.1.tar.gz (5.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page