slumber icon indicating copy to clipboard operation
slumber copied to clipboard

A library that makes consuming a RESTful API easier and more convenient

Slumber |build-status| |coverage-status| |docs|

Slumber is a Python library that provides a convenient yet powerful object-oriented interface to ReSTful APIs. It acts as a wrapper around the excellent requests_ library and abstracts away the handling of URLs, serialization, and request processing.

.. _requests: http://python-requests.org/

Getting Help

Visit IRC channel (#slumber on irc.freenode.net_) to get help, bounce ideas or generally shoot the breeze.

.. _#slumber on irc.freenode.net: irc://irc.freenode.net/slumber

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)

.. |build-status| image:: https://travis-ci.org/samgiles/slumber.svg?branch=master :target: https://travis-ci.org/samgiles/slumber :alt: Build status .. |coverage-status| image:: https://img.shields.io/coveralls/samgiles/slumber.svg :target: https://coveralls.io/r/samgiles/slumber :alt: Test coverage percentage .. |docs| image:: https://readthedocs.org/projects/slumber/badge/?version=latest :target: http://slumber.readthedocs.org/ :alt: Documentation