Skip to content

TheValiant/manpy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here is a clean, professional README.md. I have automatically corrected the URL in the install command to point to the raw version of the script, otherwise piping it to bash would fail.


manpy

manpy is a beautiful, modern alternative to Python's built-in help() or man pages. It allows you to inspect modules, classes, and function signatures directly from your terminal with syntax highlighting, smart member listings, and direct paging.

⚡ Quick Install

Copy and paste this one-liner to install manpy (updates .bashrc/.zshrc automatically):

curl -sL https://raw.githubusercontent.com/TheValiant/manpy/main/install.sh | bash

🚀 Usage

Simply use manpy followed by any Python import path. It dynamically resolves libraries without needing to manually open a Python shell.

# Inspect a module
manpy os

# Inspect a nested function
manpy random.randint

# Inspect a class
manpy collections.Counter

✨ Features

  • Syntax Highlighting: Full colored output for source code and signatures.
  • Smart Resolution: Works on built-ins, standard libraries, and installed pip packages.
  • Intelligent Views:
    • Functions: Shows signature, docstring, and source code.
    • Classes/Modules: Shows docstring and a clean table of public methods/members.
  • Error Handling: Smartly pages output using less, but prints directly to stdout if an error occurs so you don't miss the message.

Requirements

  • Python 3+
  • Rich (Installed automatically by the script)

About

makeshift python manpages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published