grip

library4.6.2pypypiunverified

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.

web-framework http-networking

pip install grip

github ↗package ↗

INSTALL

IMPORT

SIG · GRIP

grip

web-frameworkpythonv4.6.2

Install

5.1s avg

Import

—

Disk

35MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v4.6.2 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 36.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.1s · import 0.000s · 37MB

35MB installed

● package 35MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

grip

✓ import grip; grip.command()

grip is not a module with a class; it exposes a CLI and a command function.

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.

grip --version

Debug

Known issues

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

fix

Upgrade Python to 3.7+.

affects: <=4.6.2

gotchagrip 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.

affects: all

breakingIn 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.

affects: >=4.0.0

Upgrade

Version history

4.6.2latest on PyPI · released Oct 12, 2023

Audit

Dependencies

No dependency data recorded yet.

Agent activity

14 hits · last 30 days

node

Resources

githubhttp://github.com/joeyespo/grip ↗

packagehttps://pypi.org/project/grip/ ↗