docgetter 0.1.2

Command line shortcut for opening Python documentation

docgetter

Quick Start

docgetter is a command line shortcut for opening Python documentation webpages:

docs argparse
docs --pypi discord.py
docs --readthedocs array --search

Description

Suppose you're dutifully coding in your editor of choice and you have to look something up really quick. You've probably already mastered the art of Alt-Tabbing, but the documentation is still clicks away, not to mention that if it's not already open, you have to search on Google and actually use the mouse to open links (shudders). However, you always have a terminal open, so your hands never leave the keyboard.

This program currently supports three documentation websites:

1. docs.python.org for the Python standard library. ↓
2. PyPI project homepages for packages available on PyPI. ↓
3. readthedocs.io homepages for projects that host their documentation on readthedocs.io. ↓

Installation

Windows	Unix/MacOS
py -m pip install docgetter	python3 -m pip install docgetter

There are no dependencies, just pure standard library! It is OS-independent, but browser behavior may vary depending on your browser of choice as determined by the underlying webbrowser module.

Usage

$ docs --help
usage: docgetter [-h] [-p | -r] [-v] [-s] name

Open the documentation page for a module or package.

positional arguments:
  name               name of the module/package; treated by default as a
                     Python standard library module - use the -p/-r flags to
                     specify alternate documentation sites

optional arguments:
  -h, --help         show this help message and exit
  -p, --pypi         open the PyPI homepage for this package
  -r, --readthedocs  open the readthedocs.io page for this package
  -v, --version      show program's version number and exit
  -s, --search       whether to use the site's search function instead of
                     attempting to directly load a URL

By default, the supplied name is interpreted as a Python standard library module/package. You can use the -p/--pypi or -r/--readthedocs flag to specify that the name refers to a PyPI project or readthedocs.io homepage respectively instead.

You can also add the global -s/--search flag with any of these methods to specify using the site's search engine instead of attempting to directly load a URL.

Examples

Python Standard Library

docs pathlib        # Directly load pathlib's docs page
docs -s path        # Search for "path" on docs.python.org

PyPI Project Homepage

docs -p numpy           # Directly load numpy's PyPI homepage
docs --pypi pandas      # Directly load pandas' PyPI homepage
docs -ps spotify        # Search "spotify" on pypi.org

readthedocs.io Project Homepage

docs -r selenium-python     # Directly load selenium's docs page
docs --readthedocs rich     # Directly load rich's docs page
docs -rs youtube            # Search "youtube" on readthedocs.io

This tool is very simple, but I made it because it provides a shortcut to something I find myself doing very often as someone constantly bouncing between doc pages. I hope someone else finds it useful too!