# 🚀 pyhelp (Helpman)
Enhanced Python Help Tool with Rich Library - Beautiful terminal output
`pyhelp` or `helpman` is a Python command-line tool that lets you quickly view the documentation (docstring) of Python functions, classes, or objects directly from your terminal. It helps you inspect documentation without opening source files or browsing online docs.
[](https://github.com/cumulus13/pyhelp/raw/refs/heads/master/helpman_example_usage.gif)
## ✨ Features
- Displays docstrings for Python functions, classes, and objects.
- Supports searching in standard Python modules and installed third-party packages.
- Provides clean, readable output right in the terminal.
## 📦 Installation
```bash
git clone https://github.com/cumulus13/pyhelp.git
cd pyhelp
pip install .
# or
pip install helpman
```
---
## Usage
After installation, use `pyhelp` in your terminal with the following syntax:
```bash
pyhelp <object_name>
```
Replace `<object_name>` with the name of the Python function, class, or object you want to view the documentation for.
```bash
Usage: pyhelp/helpman [-h] [-s] [-a] [-i] [-v] [module ...]
🐍 Enhanced Python Help Tool with Rich formatting
Positional Arguments:
module Module, function, or class to get help for (e.g., os.path, json.loads)
Options:
-h, --help show this help message and exit
-s, --source Show source code instead of help documentation
-a, --show-all Show all the attributes
-i, --interactive Interactive mode
-v, --version show program's version number and exit
Examples:
pyhelp os.path # Show help for os.path module
pyhelp json.loads # Show help for json.loads function
pyhelp -s requests.get # Show source code for requests.get
pyhelp --source collections.Counter # Show source code for Counter class
```
You can clear the terminal while inputting a query by prefixing or suffixing with "c", e.g. "c query" or "query c".
### Examples
- View docstring for the `print` function:
```bash
pyhelp print
```
- View docstring for the `list` class:
```bash
pyhelp list
```
- View docstring for `numpy.array` function (if `numpy` is installed):
```bash
pyhelp numpy.array
```
If the requested object is not found directly, `pyhelp` will attempt to locate it in standard Python modules and installed third-party packages.
## Contribution
Contributions to improve `pyhelp` are welcome! Please fork the repository, create a new branch (`git checkout -b new-feature`), make your changes, and submit a pull request. Make sure to add tests and update documentation as needed.
## License
`pyhelp` is licensed under the [MIT License](LICENSE).
---
If you have any questions or need help, feel free to open an issue on the [GitHub repository](https://github.com/cumulus13/pyhelp/issues).
## author
[Hadi Cahyadi](mailto:cumulus13@gmail.com)
[](https://www.buymeacoffee.com/cumulus13)
[](https://ko-fi.com/cumulus13)
[Support me on Patreon](https://www.patreon.com/cumulus13)
[medium.com](https://www.medium.com/@cumulus13)
Raw data
{
"_id": null,
"home_page": "https://github.com/cumulus13/pyhelp",
"name": "helpman",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Help Tool Rich Beautiful terminal",
"author": "Hadi Cahyadi",
"author_email": "cumulus13@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d4/d8/c260ecabbfa42b409a07869211638443041999cfaf3c9e1f6c3f2d1ec561/helpman-2.33.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 pyhelp (Helpman)\r\n\r\nEnhanced Python Help Tool with Rich Library - Beautiful terminal output\r\n\r\n\r\n`pyhelp` or `helpman` is a Python command-line tool that lets you quickly view the documentation (docstring) of Python functions, classes, or objects directly from your terminal. It helps you inspect documentation without opening source files or browsing online docs.\r\n\r\n[](https://github.com/cumulus13/pyhelp/raw/refs/heads/master/helpman_example_usage.gif)\r\n\r\n## \u2728 Features\r\n\r\n- Displays docstrings for Python functions, classes, and objects.\r\n- Supports searching in standard Python modules and installed third-party packages.\r\n- Provides clean, readable output right in the terminal.\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n```bash\r\n git clone https://github.com/cumulus13/pyhelp.git\r\n cd pyhelp\r\n pip install .\r\n\r\n # or\r\n\r\n pip install helpman\r\n```\r\n---\r\n\r\n## Usage\r\n\r\nAfter installation, use `pyhelp` in your terminal with the following syntax:\r\n\r\n```bash\r\npyhelp <object_name>\r\n```\r\n\r\nReplace `<object_name>` with the name of the Python function, class, or object you want to view the documentation for.\r\n\r\n\r\n```bash\r\nUsage: pyhelp/helpman [-h] [-s] [-a] [-i] [-v] [module ...]\r\n\r\n\ud83d\udc0d Enhanced Python Help Tool with Rich formatting\r\n\r\nPositional Arguments:\r\n module Module, function, or class to get help for (e.g., os.path, json.loads)\r\n\r\nOptions:\r\n -h, --help show this help message and exit\r\n -s, --source Show source code instead of help documentation\r\n -a, --show-all Show all the attributes\r\n -i, --interactive Interactive mode\r\n -v, --version show program's version number and exit\r\n\r\nExamples:\r\n\r\n pyhelp os.path # Show help for os.path module\r\n pyhelp json.loads # Show help for json.loads function\r\n pyhelp -s requests.get # Show source code for requests.get\r\n pyhelp --source collections.Counter # Show source code for Counter class\r\n\r\n```\r\n\r\nYou can clear the terminal while inputting a query by prefixing or suffixing with \"c\", e.g. \"c query\" or \"query c\".\r\n\r\n### Examples\r\n\r\n- View docstring for the `print` function:\r\n\r\n ```bash\r\n pyhelp print\r\n ```\r\n\r\n- View docstring for the `list` class:\r\n\r\n ```bash\r\n pyhelp list\r\n ```\r\n\r\n- View docstring for `numpy.array` function (if `numpy` is installed):\r\n\r\n ```bash\r\n pyhelp numpy.array\r\n ```\r\n\r\nIf the requested object is not found directly, `pyhelp` will attempt to locate it in standard Python modules and installed third-party packages.\r\n\r\n## Contribution\r\n\r\nContributions to improve `pyhelp` are welcome! Please fork the repository, create a new branch (`git checkout -b new-feature`), make your changes, and submit a pull request. Make sure to add tests and update documentation as needed.\r\n\r\n## License\r\n\r\n`pyhelp` is licensed under the [MIT License](LICENSE).\r\n\r\n---\r\n\r\nIf you have any questions or need help, feel free to open an issue on the [GitHub repository](https://github.com/cumulus13/pyhelp/issues).\r\n\r\n\r\n## author\r\n[Hadi Cahyadi](mailto:cumulus13@gmail.com)\r\n \r\n\r\n[](https://www.buymeacoffee.com/cumulus13)\r\n\r\n[](https://ko-fi.com/cumulus13)\r\n \r\n[Support me on Patreon](https://www.patreon.com/cumulus13)\r\n\r\n[medium.com](https://www.medium.com/@cumulus13)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Enhanced Python Help Tool with Rich Library - Beautiful terminal output.",
"version": "2.33",
"project_urls": {
"Bug Reports": "https://github.com/cumulus13/pyhelp/issues",
"Documentation": "https://github.com/cumulus13/pyhelp#readme",
"Homepage": "https://github.com/cumulus13/pyhelp",
"Source": "https://github.com/cumulus13/pyhelp"
},
"split_keywords": [
"help",
"tool",
"rich",
"beautiful",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c7cc2958ca5c5ebf8b75a19b3bb16f1a711c51f322e7c4c849bdf651b47e5ba3",
"md5": "d08df244c9764e98e0d2ff873c77d313",
"sha256": "7f64a106bc44b4faa561c90e5f89c9581351acba01c6673b1209645f39ae50cb"
},
"downloads": -1,
"filename": "helpman-2.33-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d08df244c9764e98e0d2ff873c77d313",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18492,
"upload_time": "2025-08-09T11:56:45",
"upload_time_iso_8601": "2025-08-09T11:56:45.955818Z",
"url": "https://files.pythonhosted.org/packages/c7/cc/2958ca5c5ebf8b75a19b3bb16f1a711c51f322e7c4c849bdf651b47e5ba3/helpman-2.33-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4d8c260ecabbfa42b409a07869211638443041999cfaf3c9e1f6c3f2d1ec561",
"md5": "00e95a71bcae0a9c4dfd9a464a0151bd",
"sha256": "01d340a5ada8efb7ec35a51142671f8b4acfdd5a96fe628aa617dbd933551765"
},
"downloads": -1,
"filename": "helpman-2.33.tar.gz",
"has_sig": false,
"md5_digest": "00e95a71bcae0a9c4dfd9a464a0151bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19467,
"upload_time": "2025-08-09T11:56:47",
"upload_time_iso_8601": "2025-08-09T11:56:47.395912Z",
"url": "https://files.pythonhosted.org/packages/d4/d8/c260ecabbfa42b409a07869211638443041999cfaf3c9e1f6c3f2d1ec561/helpman-2.33.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-09 11:56:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cumulus13",
"github_project": "pyhelp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "rich",
"specs": [
[
">=",
"10.0.0"
]
]
},
{
"name": "licface",
"specs": []
}
],
"lcname": "helpman"
}
JSON
