1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
========
restless
========
.. image:: https://travis-ci.org/toastdriven/restless.svg?branch=master
:target: https://travis-ci.org/toastdriven/restless
.. image:: https://coveralls.io/repos/github/toastdriven/restless/badge.svg?branch=master
:target: https://coveralls.io/github/toastdriven/restless?branch=master
A lightweight REST miniframework for Python.
Documentation is at https://restless.readthedocs.io/.
Works great with Django_, Flask_, Pyramid_, Tornado_ & Itty_, but should be useful for
many other Python web frameworks. Based on the lessons learned from Tastypie_
& other REST libraries.
.. _Django: https://www.djangoproject.com/
.. _Flask: http://flask.pocoo.org/
.. _Pyramid: https://pylonsproject.org/
.. _Itty: https://pypi.org/project/itty/
.. _Tastypie: http://tastypieapi.org/
.. _Tornado: https://www.tornadoweb.org/
.. _tox: https://tox.readthedocs.io/
Features
========
* Small, fast codebase
* JSON output by default, but overridable
* RESTful
* Python 3.6+
* Django 2.2+
* 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:
.. code:: python
# posts/api.py
from django.contrib.auth.models import User
from restless.dj import DjangoResource
from restless.preparers import FieldsPreparer
from posts.models import Post
class PostResource(DjangoResource):
# Controls what data is included in the serialized output.
preparer = FieldsPreparer(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:
.. code:: python
# api/urls.py
from django.urls import include, path
from posts.api import PostResource
urlpatterns = [
# The usual suspects, then...
path('api/posts/', include(PostResource.urls())),
]
Licence
=======
BSD
Running the Tests
=================
The test suite uses tox_ for simultaneous support of multiple versions of both
Python and Django. The current versions of Python supported are:
* CPython 3.6
* CPython 3.7
* CPython 3.8
* CPython 3.9
* PyPy
You just need to install the Python interpreters above and the `tox` package
(available via `pip`), then run the `tox` command.
|
