{"id":23823,"library":"grip","title":"grip","description":"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.","status":"maintenance","version":"4.6.2","language":"python","source_language":"en","source_url":"http://github.com/joeyespo/grip","tags":["readme","preview","github","markdown"],"install":[{"cmd":"pip install grip","lang":"bash","label":"Install grip from PyPI"}],"dependencies":[],"imports":[{"note":"grip is not a module with a class; it exposes a CLI and a command function.","symbol":"grip","correct":"import grip; grip.command()"}],"quickstart":{"code":"import grip\ngrip.command(['README.md'])\n# Open http://localhost:5000 to view the rendered README.","lang":"python","description":"Start local server to render README.md with GitHub styles."},"warnings":[{"fix":"Upgrade Python to 3.7+.","message":"Python 3.6 and earlier are no longer supported. Use Python 3.7+.","severity":"deprecated","affected_versions":"<=4.6.2"},{"fix":"Use GitHub's own preview API for exact rendering.","message":"grip does not support all GitHub Flavored Markdown extensions (e.g., task lists, emoji autocomplete). The rendering is a close approximation, not identical.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `grip --help` to see the correct CLI arguments.","message":"In version 4.0, the CLI was refactored; the old `grip` command with hyphenated flags may not work. Use the new command style.","severity":"breaking","affected_versions":">=4.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use `grip README.md` from the command line, not `import grip` in Python scripts.","cause":"The library is installed but not imported correctly; grip is a CLI tool, not a Python module.","error":"ModuleNotFoundError: No module named 'grip'"},{"fix":"Omit `--user-content`; grip now always renders user content.","cause":"The `--user-content` flag was removed in a newer version.","error":"grip: error: unrecognized arguments: --user-content"},{"fix":"Use a different port: `grip README.md --port 8000`.","cause":"Another process is already bound to port 5000.","error":"OSError: [Errno 48] Address already in use"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}