grip

4.6.2 verified Fri May 01 auth: no python maintenance

Render local readme files (Markdown) in a local web server with GitHub-styled CSS, allowing you to preview how your README will look before pushing to GitHub. Version 4.6.2 is the latest stable release; development is infrequent and the library is in maintenance mode.

pip install grip

Common errors

error ModuleNotFoundError: No module named 'grip' ↓

cause The library is installed but not imported correctly; grip is a CLI tool, not a Python module.

fix

Use grip README.md from the command line, not import grip in Python scripts.

error grip: error: unrecognized arguments: --user-content ↓

cause The `--user-content` flag was removed in a newer version.

fix

Omit --user-content; grip now always renders user content.

error OSError: [Errno 48] Address already in use ↓

cause Another process is already bound to port 5000.

fix

Use a different port: grip README.md --port 8000.

Warnings

deprecated Python 3.6 and earlier are no longer supported. Use Python 3.7+. ↓

fix Upgrade Python to 3.7+.

gotcha grip does not support all GitHub Flavored Markdown extensions (e.g., task lists, emoji autocomplete). The rendering is a close approximation, not identical. ↓

fix Use GitHub's own preview API for exact rendering.

breaking In version 4.0, the CLI was refactored; the old `grip` command with hyphenated flags may not work. Use the new command style. ↓

fix Use `grip --help` to see the correct CLI arguments.

Imports

grip
```
import grip; grip.command()
```
grip is not a module with a class; it exposes a CLI and a command function.

Quickstart

Start local server to render README.md with GitHub styles.

import grip
grip.command(['README.md'])
# Open http://localhost:5000 to view the rendered README.