https://github.com/bsoyka/gmtd

Give Me the Docs finds the docs for Python packages so you don't have to.
https://github.com/bsoyka/gmtd

cli documentation gmtd pypi python

Last synced: 5 months ago
JSON representation

Give Me the Docs finds the docs for Python packages so you don't have to.

• Host: GitHub
• URL: https://github.com/bsoyka/gmtd
• Owner: bsoyka
• License: mit
• Created: 2021-11-25T16:08:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-11T01:38:33.000Z (over 4 years ago)
• Last Synced: 2025-09-25T11:25:18.497Z (9 months ago)
• Topics: cli, documentation, gmtd, pypi, python
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Give Me the Docs

**Give Me the Docs** finds the docs for Python packages so you don't have to.

```console

$ gmtd numpy

Found documentation for numpy:

    - https://numpy.org/doc/1.21

    - https://www.numpy.org

```

[![Downloads](https://pepy.tech/badge/gmtd)](https://pepy.tech/project/gmtd)

[![Supported Versions](https://img.shields.io/pypi/pyversions/gmtd.svg)](https://pypi.org/project/gmtd)

[![License](https://img.shields.io/pypi/l/gmtd)](https://github.com/bsoyka/gmtd/blob/master/LICENSE)

[![Version](https://img.shields.io/pypi/v/gmtd?label=latest)](https://pypi.org/project/gmtd)

## Installation

Give Me the Docs is available on PyPI:

```console

$ pip install gmtd

```

Give Me the Docs officially supports Python 3.8+.

## API Reference

### `gmtd.get_documentation(package_name)`

Gets the documentation URL for a package.

#### Args

* **`package`** *(`str`)*: The name of the package to get documentation for.

#### Returns:

*(`List[str]`)*: A list of possible documentation URLs for the package, ordered from most to

least likely to be official documentation.

#### Raises:

* **`PackageNotFoundError`**: If the package is not installed.