pywebdoc 0.0.1

CLI application to quickly open web documentation about Python

pywebdoc

pywebdoc is a CLI application to quickly open web documentation about Python. This tool works for standard libraries and PyPI packages. It opens web pages on your default web browser.

Installing

pywebdoc can be installed using pip:

pip3 install pywebdoc

Usage

You can see below the list of all commands you can use with pywebdoc. For more details, you can read the complete documentation here.

• Open the Python official documentation:

pywebdoc py [OPTIONS]

• Open the documentation page of a standard Python library:

pywebdoc std [OPTIONS] LIBRARY

• Open the PyPI web page of a package:

pywebdoc pypi [OPTIONS] PACKAGE

• Open the home-page of an installed PyPI package:

pywebdoc home [OPTIONS] PACKAGE

• Open the documentation page of a package on ReadTheDocs:

pywebdoc rtd [OPTIONS] PACKAGE

• Get the list of standard Python libraries:

pywebdoc list-std [OPTIONS]

• Get the list of installed PyPI packages

pywebdoc list-packages [OPTIONS]

Links

• GitHub: https://github.com/Quentin18/pywebdoc/
• PyPI: https://pypi.org/project/pywebdoc/
• Documentation: https://pywebdoc.readthedocs.io/en/latest/
• Travis: https://travis-ci.org/github/Quentin18/pywebdoc/

Author

Quentin Deschamps: [e-mail]

License

MIT