Commit Graph

363 Commits

Author SHA1 Message Date
Peter Baehr
44ae037e81 Move urls.py changes down and add necessary import
The previous location of editting urls.py did not allow migrations to be created and the default import needs to be modified
2015-12-15 21:17:52 -05:00
knbk
e203967e09 Add app_name to rest_framework.urls.
This allows users in Django 1.9+ to include the authentication urls
without specifying the namespace, as in:

    urlpatterns = [
        ...
        url(r'^auth/', include('rest_framework.urls'))
    ]
2015-12-08 02:25:00 +01:00
qqbuby
1aa16caffe append a space after the comment mark to remain consistent with the other parts of the tutorial 2015-09-13 20:24:22 +08:00
qqbuby
1a8f9d0a0f fix issue #3395 to correct the output text at line 184in docs/tutorial/1-serialization.md 2015-09-12 01:36:40 +08:00
potpath
bb95de13bf Update 6-viewsets-and-routers.md 2015-09-04 16:07:20 +07:00
ThaJay
76fedcc348 Update 2-requests-and-responses.md
just a small error, the trailing slash in the url should be omitted when adding a .suffix
2015-08-12 19:49:43 +02:00
Tom Christie
c8ad0cce19 Bump minimum Django version to 1.5 2015-07-30 15:43:39 +01:00
Tom Christie
a4e0f03050 Tweak quickstart to show newest users first in list view 2015-07-30 14:18:09 +01:00
José Padilla
7f7e6b33ff Update quickstart.md
Closes #3171
2015-07-19 21:47:09 -04:00
Leonardo Giordani
4f6eba3ce8 Removed import of unused django.forms.widgets 2015-07-16 16:25:01 +02:00
Mark Skipper
b743818430 Remove unused import from docs example 2015-07-01 20:39:05 +01:00
José Padilla
2b6726e703 Merge pull request #2842 from frnc/patch-1
Update 5-relationships-and-hyperlinked-apis.md
2015-04-26 12:13:57 -04:00
Valentin Hăloiu
e148637d6d Frontpage example no longer uses model attribute 2015-04-23 04:44:10 +03:00
frnc
601cbf18d4 Update 5-relationships-and-hyperlinked-apis.md
Following  [@jpadilla](https://github.com/jpadilla)'s suggestion in issue [#2837](https://github.com/tomchristie/django-rest-framework/issues/2837), I am proposing a little addition in "Creating an endpoint for the root of our API" section in order to make it clear that the `user-list` and `snippet-list` names will be declared later in `snippets/urls.py`. Missing this clarification might lead a beginner (like me) to think that the names are somehow assigned by rest_framework under the hood and to try the code too early, getting stuck in the following errors.
2015-04-20 17:56:04 +02:00
Oleg Marshev
b0dd1fffbf Fix typo. 2015-04-07 19:40:23 +03:00
Kyle P. Johnson
d655a423fb Add necessary imports to final urls.py example 2015-03-16 11:17:02 -04:00
Esmail
2484dbf4e1 Fix example of explicit format URL (for real).
Do what I meant to do in #2670:

The link is displayed in the tutorial as "http://example.com/api/items/4.json" but the hyperlink itself and what the example code actually works with are (in my opinion, less pretty) URLs like "http://example.com/api/items/4/.json".
2015-03-11 12:00:19 -04:00
Tom Christie
18cc0230bf Clean up pagination attributes 2015-03-04 15:51:00 +00:00
Tom Christie
fbb21caaaa Merge master 2015-02-09 20:43:50 +00:00
José Padilla
235b98e427 Merge pull request #2460 from mmarvick/master
Small fixes to the tutorial
2015-02-06 11:31:25 -04:00
Michael Marvick
5bf803b6ed Revert some of the changes made in 1-serialization.md 2015-02-05 19:42:36 -08:00
José Padilla
aaa1fcd5d1 Fixes #2493 2015-02-01 16:18:02 -04:00
Michael Marvick
73bd0d539f tutorial #5 incorrectly referenced 'settings.py' instead of 'tutorial/settings.py' 2015-01-25 23:47:01 -08:00
Michael Marvick
2a6937f381 tutorial #2 incorrectly showed /item.json instead of /item/.json for format suffixes 2015-01-25 23:46:27 -08:00
Michael Marvick
90c9968a70 tutorial #1 incorrectly showed string of json instead of ReturnDict type from 'serializer.data', and also has a third item in the second usage 2015-01-25 23:45:56 -08:00
Tom Christie
9ec08ce578 Merge master 2015-01-21 13:12:14 +00:00
Eric Theise
b0bc79ed4d correcting "it's" to "its" in Tutorial 1 2015-01-19 14:49:36 -08:00
Tom Christie
6065cdbd93 Merge master 2015-01-19 15:16:57 +00:00
Travis Swientek
8ccf5bcc0b Tweaked a few issues in the tutorial documentation. 2015-01-09 11:36:21 -08:00
Tom Christie
6168f60ba8 Merge branch 'master' into version-3.1 2015-01-05 11:02:28 +00:00
Rob Terhaar
336faf5a86 fix widget style formatting 2015-01-01 21:01:16 -05:00
Tom Christie
d109ae0a2e Merge pull request #2010 from tanwanirahul/master
Ability to customize method names without creating a custom router
2014-12-19 16:09:01 +00:00
Rahul
8f0fef4b75 Updated documentation on url_path per suggestions. 2014-12-19 21:22:10 +05:30
tanwanirahul
a8a3fedb5c Add url_path documention for detail_route decorator 2014-12-19 20:16:46 +05:30
Tom Christie
c8d88c8c8a Merge branch 'master' into version-3.1 2014-12-18 11:21:25 +00:00
Brent O'Connor
7e9aac98fe The pre_save method no longer works. This resolved issue #2306 2014-12-17 16:54:04 -06:00
Brent O'Connor
4f33cfe1a0 With httpie 0.8.0 the HTTP method has to come after the auth argument. 2014-12-17 14:38:01 -06:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
418108632c Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:23:20 +00:00
Tom Christie
90b8f9221e Use six.BytesIO in tutorial. Closes #2296. 2014-12-17 16:23:00 +00:00
Tom Christie
5f933f575e Merge pull request #2298 from epicserve/fix_typo
Fixed a typo
2014-12-17 16:20:22 +00:00
Brent O'Connor
530f7a21b3 Fixed a typo 2014-12-17 10:19:15 -06:00
Tom Christie
1ba822010d Highlight trailing '.' in command so it wont be missed. 2014-12-17 15:22:27 +00:00
Tom Christie
b6ee784240 Merge master 2014-12-15 12:18:55 +00:00
Jason Spafford
b951c74df2 Made docs consistent 2014-12-15 01:24:12 -08:00
Tom Christie
baaa356489 Merge master 2014-12-12 15:37:43 +00:00
Tom Christie
9b88b5db69 Field->ReadOnlyField in tutorial docs 2014-12-11 09:54:55 +00:00
Tom Christie
76956beab4 snippets relationship in tutorial should be read_only 2014-12-09 19:53:27 +00:00
Tom Christie
af3fe5a39f Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-08 16:38:29 +00:00
Tom Christie
4e9ebb5fe9 cd back to parent directory 2014-12-08 16:38:17 +00:00
Tom Christie
302ec59a5c Merge pull request #2165 from phalt/httpie-examples
Use httpie for tutorials
2014-12-08 15:51:19 +00:00
phalt
f3ebac061e one last tabs / spaces! 2014-12-08 15:47:49 +00:00
phalt
8e9408115d fixed indentations 2014-12-08 15:41:01 +00:00
Xavier Ordoquy
e4820d611b Fix the new Django default db name
PrimaryKeyRelatedField now needs a queryset argument.
urls now don't use urlpatterns.
2014-12-06 10:58:17 +01:00
Tom Christie
b7b0fd3e14 Added .validated_data usage. Closes #2214. 2014-12-05 12:48:12 +00:00
Tom Christie
1b8c06aefe Style tweaks in examples 2014-12-05 12:46:08 +00:00
Tom Christie
e2b3908834 Fix quickstart tutorial 2014-12-05 09:44:01 +00:00
Xavier Ordoquy
9d078be59c Fix the tutorial against the v3.0 2014-12-04 23:34:55 +01:00
Xavier Ordoquy
38e05e66c9 print() function works from Python 2.6 to 3.X 2014-12-04 23:22:00 +01:00
phalt
fcbae5d99f updates based on suggestions 2014-12-04 11:20:33 +00:00
Martin Tschammer
ab25d706c7 Renamed validated_attrs to validated_data to be more in line with other similar code. 2014-12-03 23:52:35 +01:00
phalt
a17d5d2b0b remove unsused link 2014-12-02 16:11:43 +00:00
phalt
515060a6ab Only show pip install for httpie 2014-12-02 10:16:41 +00:00
phalt
34b5db62e5 Use httpie for tutorials 2014-12-01 13:39:53 +00:00
Tymur Maryokhin
e2ea98e8ab Fixed typos 2014-11-29 20:23:55 +01:00
José Padilla
731c8421af Remove YAML support from core 2014-11-29 14:43:05 -04:00
Tom Christie
d4b8e356b9 Merge branch '3.0-docs' 2014-11-28 09:57:02 +00:00
Will Stott
d0e245baba grammar 2014-11-26 15:51:28 +00:00
Will Stott
34bd2b7828 a few typos 2014-11-26 15:48:08 +00:00
Tom Christie
f13c0ebe69 Merge master 2014-11-25 16:27:00 +00:00
José Padilla
200e0b17da Clean up extra white space 2014-11-25 12:44:11 +00:00
Tom Christie
2e726e22a3 request.DATA, request.FILES -> request.data 2014-11-25 11:42:43 +00:00
Tom Christie
3371131a61 Merge pull request #2116 from LuRsT/patch-5
Fixed database update instructions
2014-11-24 13:21:15 +00:00
Gil Gonçalves
918b9cc6a6 Added missing import in tutorial snippet 2014-11-24 08:54:07 +00:00
Gil Gonçalves
790a651893 Fixed database update instructions 2014-11-24 08:51:08 +00:00
Gil Gonçalves
04d2635b24 Removed unused import from code snippet in tutorial 2014-11-20 11:33:42 +00:00
Raony Guimarães
928cbc640e small type 2014-11-19 13:53:36 -02:00
Tom Christie
5d247a65c8 First pass on nested serializers in HTML 2014-10-09 15:11:19 +01:00
Tom Christie
a58cfe167d Update tutorial for 3.0 2014-10-09 09:38:03 +01:00
Collin Anderson
da385c9c1f remove patterns and strings from urls #1898 2014-09-23 17:10:02 -04:00
Tom Christie
9372cc8c31 Deprecate .model attribute on views 2014-08-20 16:24:52 +01:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
61a1eaa485 tabs -> spaces 2014-08-18 11:55:22 +01:00
Tom Christie
92d51c813f Merge pull request #1688 from ekonstantinidis/quick-start-order
Updated quick start project set up order
2014-08-18 11:54:14 +01:00
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