https://github.com/quentin18/pywebdoc

A CLI application to quickly open web documentation about Python
https://github.com/quentin18/pywebdoc

cli click documentation pypi python

Last synced: 8 months ago
JSON representation

A CLI application to quickly open web documentation about Python

• Host: GitHub
• URL: https://github.com/quentin18/pywebdoc
• Owner: Quentin18
• License: mit
• Created: 2020-08-02T13:00:04.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-30T23:12:04.000Z (almost 2 years ago)
• Last Synced: 2025-04-26T00:48:40.244Z (9 months ago)
• Topics: cli, click, documentation, pypi, python
• Language: Python
• Homepage: https://pywebdoc.readthedocs.io/en/latest/
• Size: 3.31 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# pywebdoc

[![Documentation Status](https://readthedocs.org/projects/pywebdoc/badge/?version=latest)](https://pywebdoc.readthedocs.io/en/latest/?badge=latest)

[![Build Status](https://travis-ci.org/Quentin18/pywebdoc.svg?branch=master)](https://travis-ci.org/Quentin18/pywebdoc)

![PyPI](https://img.shields.io/pypi/v/pywebdoc)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pywebdoc)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/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](https://github.com/Quentin18/pywebdoc/blob/master/docs/source/img/demo.gif)

## Installing

*pywebdoc* can be installed using [pip](https://pip.pypa.io/en/stable/):

```bash

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](https://pywebdoc.readthedocs.io/en/latest/). 

* **Open the Python official documentation**:

```bash

pywebdoc py [OPTIONS]

```

* **Open the documentation page of a standard Python library**:

```bash

pywebdoc std [OPTIONS] LIBRARY

```

* **Open the PyPI web page of a package**:

```bash

pywebdoc pypi [OPTIONS] PACKAGE

```

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

```bash

pywebdoc home [OPTIONS] PACKAGE

```

* **Open the documentation page of a package on [Read the Docs](https://readthedocs.org)**:

```bash

pywebdoc rtd [OPTIONS] PACKAGE

```

* **Get the list of standard Python libraries**:

```bash

pywebdoc list-std [OPTIONS]

```

* **Get the list of installed PyPI packages**

```bash

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: quentindeschamps18@gmail.com

## License

[MIT](https://choosealicense.com/licenses/mit/)