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
.. :changelog:
Changelog
=========
development version
-------------------
0.7.1
-----
* Correct support for UTF encoded responses.
0.6.2
-----
* Further Python 3 compatibility fixes, many thanks to Alexander Shchepetilnikov (irqed)
0.6.1
-----
* Remove ``simplejson`` dependency.
* Support range now Python 2.6 - Python 3.4
0.6.0
-----
* All HTTP methods support multipart/form-data. The new ``files``
parameter is directly passed to ``requests``. Thanks to Philip
Neustrom and Diego Gaustein.
0.5.2
-----
* Now compatible with ``requests`` 1.0 thanks to Matias Saguir.
* Fix bug when using default serializer. Thanks to Andy McKay
0.4.2
-----
* Support decoded unicode url fragments - Thanks @collinwat
0.4.1
-----
* Added a ``session`` kwarg to ``slumber.API`` allowing passing a ``requests`` session
that will be used instead of the slumber created one
0.4.0
-----
* *(Backwards Incompatible)* Switched from ``httplib2`` to ``requests``
* *(Backwards Incompatible)* Removed the Meta class Magic
* *(Backwards Incompatible)* Removed the ability to subclass ``slumber.API`` to specify defaults
* *(Backwards Incompatible)* New Syntax for Specifying Authentication
0.3.1
-----
* Fix regression where pre 0.3 urls were assumed to end in slash, and 0.3.0 presumed to end in not slash.
Urls are now assumed to end in a slash, and if you don't want this behavior you can disable it by the
append_slash kwarg/Meta option (set to False to disable it).
* Fix regression caused by a mistyped variable name.
0.3.0
-----
* Allowed nesting resources infinitely to allow more complex api usage.
* Cleaned up the Meta class and allow subclassing ``slumber.API``
* *(Backwards Incompatible)* Cleaned up the exception names.
* *(Backwards Incompatible)* Renamed the ``slumber.API`` serialization kwarg from
default_format to format to be more consistent
* Improved the documentation
* Added Some Tests (This could still be better)
0.2.5
-----
* Fixed https urls and the accidental force to port 80
* Fixed the assumption that all urls end in a trailing slash
0.2.4
-----
* Fixed Including of Changelog.rst
0.2.3
-----
* Updated the docs to include a section about url parameters
0.2
----
* *(Backwards Incompatible)* Move specifying a non default serializer from
``api.resource.get(format="yaml")`` to ``api.resource(format="yaml").get()``
* Reworked the internal ``Resource`` api to not clobber any kwargs passed to it. This
fixes a bug where you couldn't use ``format`` or ``url`` as the name for one of
the url parameters.
0.1.3
-----
* Fix for ``Resource.post()`` not passing kwargs to ``Resource.get()``
0.1.2
-----
* Initial public release of Slumber
Raw data
{
"_id": null,
"home_page": "http://github.com/samgiles/slumber",
"name": "slumber",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Samuel Giles",
"author_email": "sam.e.giles@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/17/3a/6d42c6a5909207aa2487fda0c6f09c7dac259e5154d6ad74ec160db69660/slumber-0.7.1.tar.gz",
"platform": "UNKNOWN",
"description": "Slumber |build-status| |coverage-status| |docs|\n===============================================\n\nSlumber is a Python library that provides a convenient yet powerful\nobject-oriented interface to ReSTful APIs. It acts as a wrapper around the\nexcellent requests_ library and abstracts away the handling of URLs, serialization,\nand request processing.\n\n.. _requests: http://python-requests.org/\n\nGetting Help\n============\n\nVisit IRC channel (`#slumber on irc.freenode.net`_) to get help, bounce ideas\nor generally shoot the breeze.\n\n.. _#slumber on irc.freenode.net: irc://irc.freenode.net/slumber\n\nQuickStart\n==========\n\n1. Install Slumber::\n\n $ pip install slumber\n\n2. Install Optional Requirement::\n\n pip install pyyaml\n\n3. Use Slumber!\n\nRequirements\n============\n\nSlumber requires the following modules.\n\n* Python 2.6+\n* requests\n* pyyaml (If you are using the optional YAML serialization)\n\n.. |build-status| image:: https://travis-ci.org/samgiles/slumber.svg?branch=master\n :target: https://travis-ci.org/samgiles/slumber\n :alt: Build status\n.. |coverage-status| image:: https://img.shields.io/coveralls/samgiles/slumber.svg\n :target: https://coveralls.io/r/samgiles/slumber\n :alt: Test coverage percentage\n.. |docs| image:: https://readthedocs.org/projects/slumber/badge/?version=latest\n :target: http://slumber.readthedocs.org/\n :alt: Documentation\n\n\n.. :changelog:\n\nChangelog\n=========\n\n\ndevelopment version\n-------------------\n\n0.7.1\n-----\n\n* Correct support for UTF encoded responses.\n\n0.6.2\n-----\n\n* Further Python 3 compatibility fixes, many thanks to Alexander Shchepetilnikov (irqed)\n\n0.6.1\n-----\n\n* Remove ``simplejson`` dependency.\n\n* Support range now Python 2.6 - Python 3.4\n\n\n0.6.0\n-----\n\n* All HTTP methods support multipart/form-data. The new ``files``\n parameter is directly passed to ``requests``. Thanks to Philip\n Neustrom and Diego Gaustein.\n\n\n0.5.2\n-----\n\n* Now compatible with ``requests`` 1.0 thanks to Matias Saguir.\n\n* Fix bug when using default serializer. Thanks to Andy McKay\n\n\n0.4.2\n-----\n\n* Support decoded unicode url fragments - Thanks @collinwat\n\n\n0.4.1\n-----\n\n* Added a ``session`` kwarg to ``slumber.API`` allowing passing a ``requests`` session\n that will be used instead of the slumber created one\n\n0.4.0\n-----\n\n* *(Backwards Incompatible)* Switched from ``httplib2`` to ``requests``\n* *(Backwards Incompatible)* Removed the Meta class Magic\n* *(Backwards Incompatible)* Removed the ability to subclass ``slumber.API`` to specify defaults\n* *(Backwards Incompatible)* New Syntax for Specifying Authentication\n\n0.3.1\n-----\n\n* Fix regression where pre 0.3 urls were assumed to end in slash, and 0.3.0 presumed to end in not slash.\n Urls are now assumed to end in a slash, and if you don't want this behavior you can disable it by the\n append_slash kwarg/Meta option (set to False to disable it).\n* Fix regression caused by a mistyped variable name.\n\n0.3.0\n-----\n\n* Allowed nesting resources infinitely to allow more complex api usage.\n* Cleaned up the Meta class and allow subclassing ``slumber.API``\n* *(Backwards Incompatible)* Cleaned up the exception names.\n* *(Backwards Incompatible)* Renamed the ``slumber.API`` serialization kwarg from\n default_format to format to be more consistent\n* Improved the documentation\n* Added Some Tests (This could still be better)\n\n0.2.5\n-----\n\n* Fixed https urls and the accidental force to port 80\n* Fixed the assumption that all urls end in a trailing slash\n\n0.2.4\n-----\n\n* Fixed Including of Changelog.rst\n\n0.2.3\n-----\n\n* Updated the docs to include a section about url parameters\n\n0.2\n----\n\n* *(Backwards Incompatible)* Move specifying a non default serializer from\n ``api.resource.get(format=\"yaml\")`` to ``api.resource(format=\"yaml\").get()``\n\n* Reworked the internal ``Resource`` api to not clobber any kwargs passed to it. This\n fixes a bug where you couldn't use ``format`` or ``url`` as the name for one of\n the url parameters.\n\n0.1.3\n-----\n\n* Fix for ``Resource.post()`` not passing kwargs to ``Resource.get()``\n\n0.1.2\n-----\n\n* Initial public release of Slumber",
"bugtrack_url": null,
"license": "UNKNOWN",
"summary": "A library that makes consuming a REST API easier and more convenient",
"version": "0.7.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c538e2cb7501c17f9367b02a8ce62cb463824f9c5f7884e4fe6c5f13cb79858",
"md5": "a20e57de50bf26358982099f82d76b5f",
"sha256": "298d0461657337416aa53c9fe54864cb5960a009beceb2058b17fa98dfb01e9b"
},
"downloads": -1,
"filename": "slumber-0.7.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "a20e57de50bf26358982099f82d76b5f",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 9723,
"upload_time": "2015-05-14T15:54:01",
"upload_time_iso_8601": "2015-05-14T15:54:01.421339Z",
"url": "https://files.pythonhosted.org/packages/9c/53/8e2cb7501c17f9367b02a8ce62cb463824f9c5f7884e4fe6c5f13cb79858/slumber-0.7.1-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "173a6d42c6a5909207aa2487fda0c6f09c7dac259e5154d6ad74ec160db69660",
"md5": "58fe531e23b7324b9fbd3faa89a115e2",
"sha256": "96899ce914f8d7862ce34f4e50af3a82e35588ab61b4912b85844479f4d177cb"
},
"downloads": -1,
"filename": "slumber-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "58fe531e23b7324b9fbd3faa89a115e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10755,
"upload_time": "2015-05-14T15:53:57",
"upload_time_iso_8601": "2015-05-14T15:53:57.617936Z",
"url": "https://files.pythonhosted.org/packages/17/3a/6d42c6a5909207aa2487fda0c6f09c7dac259e5154d6ad74ec160db69660/slumber-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2015-05-14 15:53:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "samgiles",
"github_project": "slumber",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": []
}
],
"tox": true,
"lcname": "slumber"
}