Commit Graph

329 Commits

Author SHA1 Message Date
sshquack
867e441ec0 Strip trailing spaces in tutorial 2014-08-15 20:45:28 -06:00
sshquack
14867705e9 Specify file names using standard format
+ Explicitly specify module names in the standard format similar to all
the other tutorials
+ Remove the extra quote around module name
2014-08-15 20:41:21 -06:00
nimiq
62d0d4e5d2 Fix style for some text 2014-08-06 12:45:58 +02:00
Emmanouil
18eab53e89 Updated quick start project set up order 2014-07-09 15:53:31 +01:00
Xavier Ordoquy
2489e38a06 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/viewsets.md
	rest_framework/serializers.py
	rest_framework/throttling.py
	tests/test_generics.py
	tests/test_serializers.py
	tox.ini
2014-06-23 14:02:45 +02:00
Sylvain Bellemare
e033a0b9a0 Replaced singular "is" by plural "are" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
beb7253a96 Removed unnecessary "that" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9dc5e15e5a Added missing "the" word 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9e3ba939e1 Removed superfluous "./"s 2014-05-05 20:28:00 +02:00
Sylvain Bellemare
05fc974dc9 Added missing "the" word 2014-05-05 14:44:54 +02:00
Sylvain Bellemare
cdc7d19034 Added missing "to" word 2014-05-05 14:41:10 +02:00
Xavier Ordoquy
d08536ad9d Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/fields.md
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/authentication.py
	rest_framework/serializers.py
	rest_framework/templatetags/rest_framework.py
	rest_framework/tests/test_authentication.py
	rest_framework/tests/test_filters.py
	rest_framework/tests/test_hyperlinkedserializers.py
	rest_framework/tests/test_serializer.py
	rest_framework/tests/test_testing.py
	rest_framework/utils/encoders.py
	tox.ini
2014-04-13 00:05:57 +02:00
DanSears
abb240648c clarified which urls.py to edit 2014-02-28 08:40:45 -08:00
Tom Christie
9a8082878a Use a local virtualenv, not in the users homedir. 2014-01-14 17:13:48 +00:00
Tom Christie
52686420f4 Merge branch 'bennbollay-patch-1' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/routers.md
	rest_framework/compat.py
	tox.ini
2013-12-23 09:48:59 +00:00
Tom Christie
d8a95b4b6d Back out permissions example change in favor of easier to follow example 2013-12-23 09:12:34 +00:00
amatellanes
2846ddb5d2 Simplified some examples in tutorial 2013-12-23 09:06:03 +01:00
amatellanes
74f1cf6355 Revert "Simplified some examples in tutorial"
This reverts commit d6806340e5.
2013-12-23 08:56:34 +01:00
amatellanes
d6806340e5 Simplified some examples in tutorial 2013-12-23 08:50:46 +01:00
Tom Christie
02ae1682b5 Add note on compat import in tutorial 2013-12-17 09:45:28 +00:00
Xavier Ordoquy
8026480454 Use the BytesIO for buffering bytes and import the one from the compat module. 2013-12-17 10:30:23 +01:00
Tom Christie
9c41c007af Merge branch 'master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/compat.py
2013-12-13 16:32:34 +00:00
Tom Christie
ca244ad614 Expanded notes in quickstart. Closes #1127. Closes #1128. 2013-12-13 15:30:59 +00:00
Tom Christie
075b8c1037 Add User import. Refs #599 2013-11-18 09:29:09 +00:00
Tom Christie
c3aeb16557 Update 3-class-based-views.md 2013-10-18 09:32:04 +01:00
Tom Christie
016deaf9de Merge pull request #1177 from rprince/patch-2
Mention name of file to edit
2013-10-18 01:30:17 -07:00
Tom Christie
44a0f1cfbc Merge pull request #1178 from rprince/patch-3
Using the filenames where relevant
2013-10-18 01:16:51 -07:00
Tom Christie
78c8e6de40 Update 2-requests-and-responses.md 2013-10-18 09:10:54 +01:00
Rikki
bf60848952 Using the filenames where relevant
Sometimes it's hard to tell which file the code is intended to go in. Now it spells it out.
2013-10-16 03:21:43 +01:00
Rikki
cb123e896e Mention name of file to edit
To reduce unnecessary cognitive load of the learner, name the file they are putting this code in.
2013-10-16 03:08:43 +01:00
Rikki
e83bc00323 Added name of file to edit
So reader doesn't have to remember, or check through all the files to find where this code fragment was, mention the file name when it is relevant.
2013-10-16 03:03:51 +01:00
Tom Christie
97fbc5caec Merge pull request #1157 from dpetzel/tutorial_authentication
Be sure to import UserSerializer
2013-10-11 00:36:55 -07:00
dpetzel
864497eebb Be sure to import UserSerializer 2013-10-05 23:16:58 -04:00
dpetzel
48a38386af **very minor** typo fix 2013-10-05 19:29:25 -04:00
Tom Christie
21cd638659 Merge master 2013-09-25 09:44:26 +01:00
John Mee
de6e7accef Mindnumbingly trivial single-char typo. 2013-09-23 14:03:09 +10:00
Braulio Soncco
3d8fad0444 Fixing simple typo 2013-09-18 00:33:05 -05:00
Tom Christie
8b245fed14 Add windows virtualenv activate instruction
Closes #1075.
2013-09-02 09:17:51 +01:00
tom-leys
85ab879a85 Updated tutorial part 6: 2 examples were missing includes 2013-08-31 19:40:53 +12:00
Tom Christie
c607414f16 Merge 2013-08-19 20:36:18 +01:00
martync
770d496307 Small typo 2013-08-13 09:19:40 +02:00
Veronica Lynn
4d8d2340be Fixed typos in a bunch of docs 2013-08-07 14:00:06 -04:00
Rodrigo Martell
3a898a11f7 Fix Tutorial5 serializers.py typo
[Issue #N/A]

A slight typo at Tutorial5 causing an Exception "name 'models' is
not defined". A subtle one that can confuse Python/Django noobs
like me.
2013-07-27 10:09:56 +10:00
Alex Burgel
eaae8fb2d9 Combined link_* and action_* decorators into detail_route and list_route, marked the originals as deprecated. 2013-07-15 18:35:13 -04:00
bigsassy
c875a27edf Update 1-serialization.md
Fixed typo in documentation (Testarea to Textarea)
2013-06-16 18:32:33 -03:00
Toby Champion
250dfef158 Changes 'python' to 'Python' when used in prose. 2013-06-12 14:51:17 -07:00
Tom Christie
777ecb5141 Add renderer_classes kwarg when binding snippet_highlight explicitly. Closes #923 2013-06-10 09:05:44 +01:00
Areski Belaid
ffdf633aa5 Fix on documentation - wrong reference at previous created view UserList / UserDetail 2013-06-05 14:19:36 +02:00
Tom Christie
233320691e Rephrase serializer -> form notes in tutorial 2013-05-30 11:47:41 +01:00
Tom Christie
441cdf8065 Note widget attribute on serializer field. Closes #836. 2013-05-30 11:34:09 +01:00
Tom Christie
8d4bcb4b4c Fix quickstart urls module name. Closes #902 2013-05-30 11:12:19 +01:00
Stephan Groß
7a570e16e9 Fix md formatting and typos 2013-05-28 17:13:12 +02:00
Pascal Borreli
8f35ac4f93 Fixed typos 2013-05-28 15:09:23 +01:00
Andrew Tarzwell
62c7326b77 Update Typo 2013-05-20 17:43:37 -03:00
Tom Christie
6fcffcc9c6 Typo 2013-05-20 14:02:19 +01:00
Tom Christie
bc8671d7ea More explicit quickstart guide. Closes #867. 2013-05-20 13:43:26 +01:00
Tom Christie
fd84cf7f10 Docs tweaks 2013-05-10 21:56:33 +01:00
Daniel Hepper
70b8e5b759 Fixed typos in tutorial 2013-05-07 19:16:03 +02:00
Tom Christie
a8e090df04 Remove accidental conflict diff 2013-05-07 17:14:25 +01:00
Tom Christie
b70c9cc107 Merge master 2013-05-05 18:12:35 +01:00
Tom Christie
74beaefd12 Simplifying bits of docs 2013-05-02 12:08:05 +01:00
Victor Shih
8cabae22c5 Example and spelling fixes. Change "browseable" to "browsable" for consistency. 2013-05-01 21:26:40 -07:00
Tom Christie
8fa79a7fd3 Deal with List/Instance suffixes for viewsets 2013-04-26 14:59:21 +01:00
Tom Christie
b94da2468c Various clean up and lots of docs 2013-04-24 22:40:24 +01:00
Tom Christie
835d3f89d3 Merge remove-django-generics 2013-04-23 11:59:13 +01:00
Tom Christie
371698331c Tweaks 2013-04-04 22:24:30 +01:00
Tom Christie
ad9aa23198 Use consistent header style in tutorial part 5 2013-04-04 21:51:41 +01:00
Tom Christie
fb41d2ac8f Add support for action and link routing 2013-04-04 20:35:40 +01:00
Tom Christie
ec076a0078 Add viewsets/routers to indexs etc 2013-03-31 11:36:58 +01:00
Tom Christie
97aa023916 Updating tutorial 2013-03-30 17:22:52 +00:00
Tom Christie
b4945f476c Merge branch 'master' into resources-routers 2013-03-30 15:41:38 +00:00
Sitong Peng
dab158e1fd Tiny typo 2013-03-25 09:27:12 -07:00
Tom Christie
74fb366c59 Merge branch 'master' into resources-routers 2013-03-18 21:03:05 +00:00
Tom Christie
ef0caf64d3 Extra note on method 2013-03-17 19:59:13 +00:00
Danilo Bargen
70db398595 Renamed UserInstance to UserDetail in docs 2013-02-25 21:31:12 +01:00
Tom Christie
4599cd97cb Fix curl response.
Didn't map to the correct stage of the tutorial.
2013-02-23 22:13:06 +00:00
Tom Christie
ea7d73f57e Spelling. 2013-02-23 22:07:33 +00:00
Tom Christie
4a80dff1ef Autenticating with curl example. 2013-02-23 21:52:46 +00:00
Tom Christie
9e2131715a Formatting. 2013-02-23 21:52:26 +00:00
Tom Christie
5b03de8287 Add curl examples. 2013-02-23 21:29:52 +00:00
Tom Christie
41d3fe09cf Add missing blank=True to model in tutorial. 2013-02-23 21:29:13 +00:00
eofs
34145408cb Missing imports added 2013-02-14 13:21:54 +02:00
Tom Christie
55fdac4176 Use many=True for serializers. 2013-02-12 08:58:28 +00:00
Tom Christie
09b01887f2 New style object-level permission checks 2013-02-12 08:58:28 +00:00
Tom Christie
b1ae82b498 And link to quickstart. 2013-01-28 07:52:22 +00:00
Tom Christie
b11628f429 Revert comment. 2013-01-28 07:52:04 +00:00
Mike TUMS
c1dc1860da Update docs/tutorial/1-serialization.md
Update for tutorials (manual serialization) to support HTTP PATCH method (partial update of instance)
2013-01-28 00:32:32 +04:00
Guglielmo
25f2d3b561 Update docs/tutorial/4-authentication-and-permissions.md
HTMLFormatter is in pygments.formatters.html
2013-01-25 18:16:14 +01:00
Tom Christie
4b0d4288c1 Tweak linking style. 2013-01-24 13:01:28 +00:00
Tom Christie
a57c0c5aae Docs tweak based on user feedback. 2013-01-23 19:03:55 +00:00
Tom Christie
2c76212e54 Add missing import to tutorial. Fixes #599 2013-01-20 16:38:32 +00:00
Tom Christie
af3fd09845 Tweak imports in tutorial. Fixes #597. 2013-01-19 15:31:21 +00:00
Tom Christie
4c63961087 Tweak resource docs 2013-01-17 12:30:28 +00:00
Tom Christie
4a7139e41d Tweaks 2013-01-15 21:49:24 +00:00
Tom Christie
71e55cc4f6 Merge with latest master 2013-01-15 17:53:24 +00:00
Tom Christie
8f3931e02d Update docs 2013-01-15 17:50:39 +00:00
Tom Christie
79f635e0dd Modify tutorial to work with pygments 1.6rc. Fixes #581. 2013-01-15 09:33:24 +00:00
Richard Wackerbarth
08943c3e0a Format extensions have already been introduced.
If format extensions are used,
they must be used in the creation of the
reverse URLs.
2013-01-13 12:09:49 -06:00
Richard Wackerbarth
0987bed2f7 Minor gramatical correction 2013-01-12 12:36:21 -06:00
Richard Wackerbarth
7dd5c56f22 Make the whitespace uniform 2013-01-10 16:16:30 -06:00
Richard Wackerbarth
12efd78fcf Bringing up the Web API 2013-01-10 15:37:49 -06:00
Richard Wackerbarth
8efd9563a6 Some comment on the tutorial repository 2013-01-10 15:37:33 -06:00
Richard Wackerbarth
674c9029c1 Imply an additional element in infinite lists
This is to allow the addition of elements without
having to change existing lines of code
2013-01-10 15:37:15 -06:00
Tom Christie
0418cebc58 Update contact details 2012-12-17 22:00:25 +00:00
Colin Murtaugh
9188d487c3 Replaced SingleObjectBaseView with SingleObjectAPIView 2012-12-11 17:26:08 -05:00
Reinout van Rees
7a110a3006 Two typo fixes.
Plural/singular fix.
Typo fixed.
2012-12-05 16:24:41 +01:00
Reinout van Rees
3f39828788 Small textual fixes. 2012-12-05 16:16:46 +01:00
Reinout van Rees
ee184b8629 Small textual fixes. 2012-12-05 16:08:13 +01:00
Reinout van Rees
cb4e857217 Textual fixes.
Added a sentence introducing the second view.
Fix one or two additional sentences.
2012-12-05 16:04:52 +01:00
Reinout van Rees
3417c4631d Fixed typos and fixed wording.
Some singular/plural fixes.
Fixed some 'serialise->serialize' kind of UK/US differences. The 'z' seems more common in the rest of the docs, so that's what I used.
Removed a half-finished-sentence left dangling somewhere.
2012-12-05 12:31:38 +01:00
Reinout van Rees
fc6dbb45e0 Fixed wording. 2012-12-05 12:20:03 +01:00
mvdwaeter
3e8336af50 Fixed typo in import statement of tutorial 2012-11-30 21:50:51 +01:00
Stephan Groß
f3e598e753 Merge pull request #455 from oaubert/patch-2
Tutorial: fix module name in section 3
2012-11-27 07:56:55 -08:00
Olivier Aubert
71129dc747 Tutorial: fix module name in section 3
Again snippet -> snippets, but then it could be simpler (and possibly intended) to rename snippets to snippet in the first section of the tutorial.
2012-11-27 15:30:14 +01:00
Olivier Aubert
af8beb90c2 Tutorial: fix module name in section 2
snippet -> snippets (to match section 1).
2012-11-27 15:19:49 +01:00
Eugene MechanisM
4068323df4 Missing import of "Permission" model in docs
Missing import of "Permission" model in docs
2012-11-17 04:03:43 +04:00
Tom Christie
b7b942c599 Swap position of instance and data keyword arguments. 2012-11-05 10:53:20 +00:00
Tom Christie
36e21153fb Merge master 2012-11-01 23:11:28 +00:00
Tom Christie
d327c5f531 Relational field support in browseable API.
Add slug relational fields.
Add quickstart.
2012-11-01 23:04:13 +00:00
Pavel Savchenko
9a0cc7c720 since MultipleObjectBaseView was renamed MultipleObjectAPIView, it stands to reason to complete the renaming in docs and comments as well. 2012-11-01 15:06:11 +02:00
Stephan Groß
de2ef5d9c2 fixed typo 2012-10-31 11:12:09 +01:00
Pavel Savchenko
a3ace366db using 'pk' in fields throws KeyError
add missing imports
Browsable API seems to be working fine with FBV's (2.0.0)
removing snippets from the URI doesn't make sense
remain consistent in using SnippetDetail
2012-10-31 00:37:30 +02:00
Tom Christie
a13aaea78d Merge pull request #341 from minddust/restframework2
fix ModelSerializer useage
2012-10-30 07:06:53 -07:00
Tom Christie
4cdd0b845e Final docs tweaks for 2.0 2012-10-30 13:59:31 +00:00
Stephan Groß
3216ac0224 added missing word + removed double whitespace 2012-10-30 14:53:38 +01:00
Stephan Groß
aa081678d5 added missing word 2012-10-30 14:38:23 +01:00
Stephan Groß
a967187b41 fixed typo 2012-10-30 14:36:37 +01:00
Stephan Groß
abf7f11619 fixed typo 2012-10-30 14:11:36 +01:00
Stephan Groß
bcfb46eedc removed empty row 2012-10-30 14:02:12 +01:00
Stephan Groß
9aa3726009 fix ModelSerializer useage
cause of:
from snippets.models import Snippet
2012-10-30 13:50:07 +01:00
Tom Christie
41ab18b13e Docs update 2012-10-30 12:23:17 +00:00
Tom Christie
29bc52096a Docs tweaks for tutorial. 2012-10-30 11:55:02 +00:00
Stephan Groß
c6240f4514 removed empty row 2012-10-29 08:58:29 +01:00
Stephan Groß
76db7d4c59 correct code indent 2012-10-29 08:54:14 +01:00
Tom Christie
411c95ea0e Tweaks 2012-10-28 20:54:12 +00:00
Tom Christie
f2d6346776 Add initial explanatory paragraph 2012-10-28 20:50:37 +00:00
Tom Christie
db635fa632 Minor fixes 2012-10-28 19:37:27 +00:00
Tom Christie
fde79376f3 Pastebin tutorial 2012-10-28 19:25:51 +00:00
Tom Christie
195006bbc3 Drop resources from codebase since implementation is only partial (Created resoorces-routers branch for future reference) 2012-10-26 09:27:59 +01:00
Tom Christie
04ae32c934 remove no-site-packages since that's now the default 2012-10-25 17:01:00 +01:00
Marko Tibold
71a93930fd Fixing spelling errors. 2012-10-21 16:34:07 +02:00
Tom Christie
fed235dd01 Make settings consistent with corrosponding view attributes 2012-10-17 23:09:11 +01:00
Tom Christie
99d48f9003 Drop .parse_string_or_stream() - keep API minimal. 2012-10-17 22:07:56 +01:00
Jamie Matthews
7367bd53a9 Fix tiny typo 2012-10-12 10:02:21 +02:00
Tom Christie
44281c3996 Remove 'tut 6 - resources' from the docs, since it doesn't exist yet 2012-10-10 09:36:18 +01:00
Tom Christie
ce21fa1dc6 Tweak static files with docs 2012-10-09 14:12:38 +01:00
Tom Christie
94401b43d2 Flesh out quickstart guide and make some style tweaks 2012-10-09 13:50:26 +01:00
Tom Christie
e9475d036f Tweak settings in quickstart guide 2012-10-09 12:03:29 +01:00
Tom Christie
115e61be09 Added quickstart guide 2012-10-09 12:01:17 +01:00
Tom Christie
b581ffe323 Docs tweaks 2012-10-08 15:46:52 +01:00
Tom Christie
84958d131a Doc style tweaks 2012-10-05 15:22:30 +01:00
Tom Christie
d8b05201ed Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-03 09:46:12 +01:00
Tom Christie
c30e0795be Rename generic views 2012-10-03 09:26:15 +01:00
Matt Bosworth
934492ebd0 Fixed references to serializer.serialized and serializer.serialized_errors
in part 3 of the tutorial.  Altered part 1 to use blogs/urls.py since it was
specified at the beginning.  Also caught some spelling errors while I was at it.
2012-10-02 22:41:03 -07:00
Tom Christie
6fc5581a8f Add readonly 'id' field 2012-09-25 13:40:16 +01:00
Tom Christie
4fb57d28e6 Add csrf note 2012-09-25 12:27:46 +01:00
Tom Christie
921c5840aa Fix incorrect bit of tutorial 2012-09-25 12:21:35 +01:00
Tom Christie
4b691c4027 Change package name: djangorestframework -> rest_framework 2012-09-20 13:06:27 +01:00
Tom Christie
575630d7c3 Use named links in tutorial docs 2012-09-19 13:02:10 +01:00
Tom Christie
308677037f Tweak docs, fix .error_data -> .errors 2012-09-17 20:19:45 +01:00
Tom Christie
f204439fa8 Merge branch 'browsable-bootstrap' of https://github.com/droptype/django-rest-framework into droptype-browsable-bootstrap 2012-09-14 12:52:12 +01:00
Tom Christie
eb761be9d0 Flesh out resources/routers part of tutorial 2012-09-14 12:43:14 +01:00
Alec Perkins
60e6bba12b Browsable API doc topic 2012-09-09 17:02:19 -04:00
Tom Christie
5d9dfcd8ae Code highlighting in docs 2012-09-08 20:23:32 +01:00
Tom Christie
8f119a8c34 Merge pull request #253 from droptype/rf2-docfixes
Fixes for the documentation styles
2012-09-07 15:25:58 -07:00
Marko Tibold
8ee763739d Add some missing imports.
Fix some typos.
Fix some indentation errors.
2012-09-07 22:53:02 +02:00
Alec Perkins
f95f96aba7 [docs] Fix typo, add link to Tom's Twitter profile 2012-09-07 14:31:24 -04:00
Tom Christie
a01d615354 Add note re. browseable API and @api_view decorator 2012-09-07 13:55:02 +01:00
Tom Christie
da5a6243f3 Filling out docs a bit more 2012-09-07 09:37:06 +01:00
Tom Christie
6e21915934 First pass at mixins & generic views 2012-09-03 17:49:22 +01:00
Tom Christie
1a1ccf94c2 Fixes to APIView 2012-09-03 16:42:57 +01:00
Tom Christie
93189ec27d Added format_suffix_patterns, and fix up settings 2012-09-03 16:06:17 +01:00
Tom Christie
149b00a070 Added the api_view decorator 2012-09-03 15:57:43 +01:00
Tom Christie
7abef9ac3b Parsers may return raw data, or a DataAndFiles object 2012-09-03 14:28:40 +01:00
Tom Christie
d180e984e9 Neater virtualenv in tutorial 2012-09-03 13:44:49 +01:00
Tom Christie
a25b4be441 Support generators 2012-09-03 13:30:20 +01:00
Tom Christie
ebbaff0853 Update virtualenv notes 2012-09-03 13:10:39 +01:00
Tom Christie
247a422a64 Add virtualenv to start of tutorial 2012-09-03 12:41:52 +01:00
Tom Christie
578017e01d New docs 2012-08-29 20:57:37 +01:00