Skip to content
pyreadme - Python interface for the HTTP API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

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

  • Wrap complete HTTP API for version "v1"
  • Add CLI
  • Make it easy to manage projects from GitHub
  • Add sufficient test suite
You can’t perform that action at this time.