pyreadme - Python interface for the HTTP API

View the Project on GitHub maxpumperla/pyreadme

pyreadme - Python interface for the HTTP API

NOTE: This library is pre-release and still in testing phase.


git clone
cd pyreadme
python develop

Getting started

First time you log into a new project, do:

from pyreadme import login

login(project='your_readme.io_project', email='your@email', password='youR_P4ssWord')

pyreadme will store credentials for each project you have, so next time around you can simply do:


and will be good to go. To get document details for a slug and a version of your docs, you do

details = get_document_details(slug='your-slug', version='v1.0')

Under development