Slumber documentation

Slumber is a python library that provides a convenient yet powerful object orientated interface to ReSTful APIs. It acts as a wrapper around the excellent requests library and abstracts away the handling of urls, serialization, and processing requests.

• Getting Started with Slumber
  • Installation
  • Using
  • Url Parameters
  • Nested Resources
• Options
  • Authentication
  • File uploads
  • Serializer
  • Slashes
• How Slumber Works Behind the Scenes
  • Python to Url Translation
  • (De)Serialization

Getting Help

There are two primary ways of getting help. I have an IRC channel (#slumber on irc.freenode.net) to get help, want to bounce idea or generally shoot the breeze.

QuickStart

1. Install Slumber:

   $ pip install slumber
   

2. Install Optional Requirement:

   pip install pyyaml
   

3. Use Slumber!

Requirements

Slumber requires the following modules:

• Python 2.6+
• requests
• pyyaml (If you are using the optional yaml serialization)

Testing Slumber requires the following modules:

• Mock

Indices and tables

• Index
• Module Index
• Search Page