Render local readme files before sending off to Github.

http://github.com/joeyespo/grip

Grip is a server written in Python that uses the Github markup API to render a local readme. The styles also come directly from Github, so you'll know exactly how it will appear.

The package includes both a command-line interface and a Python API.

Sometimes you just want to see the exact readme result before committing and pushing to Github.

The command-line interface is simple. To render the readme of a repository:

$ cd myrepo
$ grip

Now open a browser and visit http://localhost:5000.

You can also specify your own port:

$ grip 8080

You can access the API directly with Python, using it in your own projects:

from grip import serve

serve(directory='path-to-your-file', port=8080)

Other functions include: find_readme, render_content, and render_page

To install grip, simply:

$ pip install grip