https://github.com/lebedov/fuzzdoc
Fuzzy select topic to view with pydoc
https://github.com/lebedov/fuzzdoc
fzf pydoc
Last synced: 16 days ago
JSON representation
Fuzzy select topic to view with pydoc
- Host: GitHub
- URL: https://github.com/lebedov/fuzzdoc
- Owner: lebedov
- License: other
- Created: 2019-11-14T16:28:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-25T12:32:12.000Z (over 5 years ago)
- Last Synced: 2025-04-16T12:21:24.108Z (about 1 month ago)
- Topics: fzf, pydoc
- Language: Python
- Size: 12.7 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.rst
Awesome Lists containing this project
README
.. -*- rst -*-
fuzzdoc
=======
Package Description
-------------------
fuzzdoc is a command line utility for fuzzy search and selection of Python
documentation to view with `pydoc `_.
.. image:: https://img.shields.io/pypi/v/fuzzdoc.svg
:target: https://pypi.python.org/pypi/fuzzdoc
:alt: Latest Version
Installation
------------
First install `fzf `_. If you
have `pip `_ installed, run::
pip install fuzzdoc
You can also download the source tarball, unpack, and run::
python setup.py install
Usage
-----
If specified without any arguments, fuzzdoc will list all found Python
keywords, pydoc help topics, packages, modules, and any public functions or
classes defined in them and display the documentation of the selected item.
If a string is specified as an argument, it is used to filter the list of available topics via substring matching.
Author
------
See the included `AUTHORS.rst
`_ file for more
information.
License
-------
This software is licensed under the `BSD License
`_. See the included
`LICENSE.rst `_ file
for more information.