Skip to main content

CLI application to quickly open web documentation about Python

Project description

pywebdoc

Documentation Status Build Status PyPI PyPI - Python Version License: MIT

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.

Demo

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

Author

Quentin Deschamps: quentindeschamps18@gmail.com

License

MIT

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 pywebdoc, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pywebdoc-0.0.1-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pywebdoc-0.0.1.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page