Metadata-Version: 1.1
Name: restless
Version: 1.3.0
Summary: A lightweight REST miniframework for Python.
Home-page: http://github.com/toastdriven/restless/
Author: Daniel Lindsley
Author-email: daniel@toastdriven.com
License: UNKNOWN
Description: ========
        restless
        ========
        
        .. image:: https://travis-ci.org/toastdriven/restless.png?branch=master
                :target: https://travis-ci.org/toastdriven/restless
        
        A lightweight REST miniframework for Python.
        
        Documentation is at http://restless.readthedocs.org/.
        
        Works great with Django, Flask, Pyramid & Itty, but should be useful for many
        other Python web frameworks. Based on the lessons learned from Tastypie_ &
        other REST libraries.
        
        .. _Tastypie: http://tastypieapi.org/
        
        
        Features
        ========
        
        * Small, fast codebase
        * JSON output by default, but overridable
        * RESTful
        * Python 3.3+ (with shims to make broke-ass Python 2.6+ work)
        * Flexible
        
        
        Anti-Features
        =============
        
        (Things that will never be added...)
        
        * Automatic ORM integration
        * Authorization (per-object or not)
        * Extensive filtering options
        * XML output (though you can implement your own)
        * Metaclasses
        * Mixins
        * HATEOAS
        
        
        Why?
        ====
        
        Quite simply, I care about creating flexible & RESTFul APIs. In building
        Tastypie, I tried to create something extremely complete & comprehensive.
        The result was writing a lot of hook methods (for easy extensibility) & a lot
        of (perceived) bloat, as I tried to accommodate for everything people might
        want/need in a flexible/overridable manner.
        
        But in reality, all I really ever personally want are the RESTful verbs, JSON
        serialization & the ability of override behavior.
        
        This one is written for me, but maybe it's useful to you.
        
        
        Manifesto
        =========
        
        Rather than try to build something that automatically does the typically
        correct thing within each of the views, it's up to you to implement the bodies
        of various HTTP methods.
        
        Example code::
        
            # posts/api.py
            from django.contrib.auth.models import User
        
            from restless.dj import DjangoResource
        
            from posts.models import Post
        
        
            class PostResource(DjangoResource):
                # Controls what data is included in the serialized output.
                fields = {
                    'id': 'id',
                    'title': 'title',
                    'author': 'user.username',
                    'body': 'content',
                    'posted_on': 'posted_on',
                }
        
                # GET /
                def list(self):
                    return Post.objects.all()
        
                # GET /pk/
                def detail(self, pk):
                    return Post.objects.get(id=pk)
        
                # POST /
                def create(self):
                    return Post.objects.create(
                        title=self.data['title'],
                        user=User.objects.get(username=self.data['author']),
                        content=self.data['body']
                    )
        
                # PUT /pk/
                def update(self, pk):
                    try:
                        post = Post.objects.get(id=pk)
                    except Post.DoesNotExist:
                        post = Post()
        
                    post.title = self.data['title']
                    post.user = User.objects.get(username=self.data['author'])
                    post.content = self.data['body']
                    post.save()
                    return post
        
                # DELETE /pk/
                def delete(self, pk):
                    Post.objects.get(id=pk).delete()
        
        Hooking it up::
        
            # api/urls.py
            from django.conf.urls.default import url, patterns, include
        
            from posts.api import PostResource
        
            urlpatterns = patterns('',
                # The usual suspects, then...
        
                url(r'^api/posts/', include(PostResource.urls())),
            )
        
        
        Licence
        =======
        
        BSD
        
        
        Running the Tests
        =================
        
        Getting the tests running looks like::
        
            $ virtualenv -p python3 env3
            $ . env3/bin/activate
            $ pip install -r test_requirements.txt
            $ export PYTHONPATH=`pwd`
            $ nosetests -s -v --with-coverage --cover-package=restless --cover-html tests
        
        For Python 2::
        
            $ virtualenv env2
            $ . env2/bin/activate
            $ pip install -r test_requirements.txt
            $ export PYTHONPATH=`pwd`
            $ nosetests -s -v --with-coverage --cover-package=restless --cover-html tests
        
        Coverage is at about 94%, so please don't make it worse. :D
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Flask
Classifier: Framework :: Pyramid
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires: six(>=1.4.0)
