def pre_save(self, obj):
diff --git a/api-guide/pagination.html b/api-guide/pagination.html
index 395a94ec8..d3a268fb5 100644
--- a/api-guide/pagination.html
+++ b/api-guide/pagination.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/parsers.html b/api-guide/parsers.html
index 5a4fcd7cf..a7a878989 100644
--- a/api-guide/parsers.html
+++ b/api-guide/parsers.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/permissions.html b/api-guide/permissions.html
index 7153f0c2a..8ad8f8c6c 100644
--- a/api-guide/permissions.html
+++ b/api-guide/permissions.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/relations.html b/api-guide/relations.html
index d4bdc3931..34252036a 100644
--- a/api-guide/relations.html
+++ b/api-guide/relations.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/renderers.html b/api-guide/renderers.html
index 11b0e1613..cb723e6a9 100644
--- a/api-guide/renderers.html
+++ b/api-guide/renderers.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -338,14 +339,14 @@ Unlike other renderers, the data passed to the Response does not ne
The return result of calling view.get_template_names().
An example of a view that uses TemplateHTMLRenderer:
-class UserDetail(generics.RetrieveUserAPIView):
+class UserDetail(generics.RetrieveAPIView):
"""
A view that returns a templated HTML representations of a given user.
"""
queryset = User.objects.all()
renderer_classes = (TemplateHTMLRenderer,)
- def get(self, request, *args, **kwargs)
+ def get(self, request, *args, **kwargs):
self.object = self.get_object()
return Response({'user': self.object}, template_name='user_detail.html')
diff --git a/api-guide/requests.html b/api-guide/requests.html
index ee15a0a8a..9a496e30d 100644
--- a/api-guide/requests.html
+++ b/api-guide/requests.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/responses.html b/api-guide/responses.html
index 9c4707401..b14730378 100644
--- a/api-guide/responses.html
+++ b/api-guide/responses.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/reverse.html b/api-guide/reverse.html
index 172ef1e85..d6af0887f 100644
--- a/api-guide/reverse.html
+++ b/api-guide/reverse.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/routers.html b/api-guide/routers.html
index e3d212da5..0bc72e5ff 100644
--- a/api-guide/routers.html
+++ b/api-guide/routers.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/serializers.html b/api-guide/serializers.html
index 39ca749c6..c7baee146 100644
--- a/api-guide/serializers.html
+++ b/api-guide/serializers.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/settings.html b/api-guide/settings.html
index 0ab1f6758..f265863ce 100644
--- a/api-guide/settings.html
+++ b/api-guide/settings.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html
index c6a3dea89..906b2f9e5 100644
--- a/api-guide/status-codes.html
+++ b/api-guide/status-codes.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/testing.html b/api-guide/testing.html
index 7f90df040..df09659ea 100644
--- a/api-guide/testing.html
+++ b/api-guide/testing.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/throttling.html b/api-guide/throttling.html
index 7f8539f09..cb633916f 100644
--- a/api-guide/throttling.html
+++ b/api-guide/throttling.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/views.html b/api-guide/views.html
index 21c4ce4e1..c8338560e 100644
--- a/api-guide/views.html
+++ b/api-guide/views.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/api-guide/viewsets.html b/api-guide/viewsets.html
index a9952205a..0b3293e30 100644
--- a/api-guide/viewsets.html
+++ b/api-guide/viewsets.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -347,7 +348,7 @@ class UserViewSet(viewsets.ModelViewSet):
The ModelViewSet class inherits from GenericAPIView and includes implementations for various actions, by mixing in the behavior of the various mixin classes.
The actions provided by the ModelViewSet class are .list(), .retrieve(), .create(), .update(), and .destroy().
Example
-Because ModelViewSet extends GenericAPIView, you'll normally need to provide at least the queryset and serializer_class attributes. For example:
+Because ModelViewSet extends GenericAPIView, you'll normally need to provide at least the queryset and serializer_class attributes, or the model attribute shortcut. For example:
class AccountViewSet(viewsets.ModelViewSet):
"""
A simple ViewSet for viewing and editing accounts.
diff --git a/img/travis-status.png b/img/travis-status.png
new file mode 100644
index 000000000..fec98cf9b
Binary files /dev/null and b/img/travis-status.png differ
diff --git a/index.html b/index.html
index b7bc4f795..468eef085 100644
--- a/index.html
+++ b/index.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -364,6 +365,7 @@ urlpatterns = patterns('',
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/2.2-announcement.html b/topics/2.2-announcement.html
index dfb710ee3..4b3b1b5b3 100644
--- a/topics/2.2-announcement.html
+++ b/topics/2.2-announcement.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/2.3-announcement.html b/topics/2.3-announcement.html
index 3ac50d6d5..c2f7eb764 100644
--- a/topics/2.3-announcement.html
+++ b/topics/2.3-announcement.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/ajax-csrf-cors.html b/topics/ajax-csrf-cors.html
index 0c90d60cb..5f7f51ae4 100644
--- a/topics/ajax-csrf-cors.html
+++ b/topics/ajax-csrf-cors.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/browsable-api.html b/topics/browsable-api.html
index f85235117..6306c97e2 100644
--- a/topics/browsable-api.html
+++ b/topics/browsable-api.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/browser-enhancements.html b/topics/browser-enhancements.html
index 118d290cb..c62c7f713 100644
--- a/topics/browser-enhancements.html
+++ b/topics/browser-enhancements.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/contributing.html b/topics/contributing.html
index 7170c91d5..0c1f0da9c 100644
--- a/topics/contributing.html
+++ b/topics/contributing.html
@@ -6,7 +6,7 @@
-
+
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -168,16 +169,18 @@
- Contributing to REST framework
-- Community
+- Community
+- Code of conduct
- Issues
+- Triaging issues
- Development
-- Testing
+- Testing
+- Pull requests
+- Managing compatibility issues
- Documentation
- Building the documentation
- Language style
- Markdown style
-- Third party packages
-- Core committers
@@ -215,44 +218,61 @@
There are many ways you can contribute to Django REST framework. We'd like it to be a community-led project, so please get involved and help shape the future of the project.
-Community
-If you use and enjoy REST framework please consider staring the project on GitHub, and upvoting it on Django packages. Doing so helps potential new users see that the project is well used, and help us continue to attract new users.
-You might also consider writing a blog post on your experience with using REST framework, writing a tutorial about using the project with a particular javascript framework, or simply sharing the love on Twitter.
+Community
+The most important thing you can do to help push the REST framework project forward is to be actively involved wherever possible. Code contributions are often overvalued as being the primary way to get involved in a project, we don't believe that needs to be the case.
+If you use REST framework, we'd love you to be vocal about your experiances with it - you might consider writing a blog post on your experience with using REST framework, or publishing a tutorial about using the project with a particular javascript framework. Experiances from beginners can be particularly helpful because you'll be in the best position to assess which bits of REST framework are and aren't easy to understand and work with.
Other really great ways you can help move the community forward include helping answer questions on the discussion group, or setting up an email alert on StackOverflow so that you get notified of any new questions with the django-rest-framework tag.
When answering questions make sure to help future contributors find their way around by hyperlinking wherever possible to related threads and tickets, and include backlinks from those items if relevant.
+Code of conduct
+Please keep the tone polite & professional. For some users a discussion on the REST framework mailing list or ticket tracker may be their first engagement with the open source community. First impressions count, so let's try to make everyone feel welcome.
+Be mindful in the language you choose. As an example, in an environment that is heavily male-dominated, posts that start 'Hey guys,' can come across as unintentionally exclusive. It's just as easy, and more inclusive to use gender neutral language in those situations.
+The Django code of conduct gives a fuller set of guidelines for participating in community forums.
Issues
-It's really helpful if you make sure you address issues to the correct channel. Usage questions should be directed to the discussion group. Feature requests, bug reports and other issues should be raised on the GitHub issue tracker.
+It's really helpful if you can make sure to address issues on the correct channel. Usage questions should be directed to the discussion group. Feature requests, bug reports and other issues should be raised on the GitHub issue tracker.
Some tips on good issue reporting:
- When describing issues try to phrase your ticket in terms of the behavior you think needs changing rather than the code you think need changing.
- Search the issue list first for related items, and make sure you're running the latest version of REST framework before reporting an issue.
--
-
If reporting a bug, then try to include a pull request with a failing test case. This will help us quickly identify if there is a valid issue, and make sure that it gets fixed more quickly if there is one.
-
--
-
TODO: Triage
-
+- If reporting a bug, then try to include a pull request with a failing test case. This will help us quickly identify if there is a valid issue, and make sure that it gets fixed more quickly if there is one.
+
+Triaging issues
+Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to
+
+- Read through the ticket - does it make sense, is it missing any context that would help explain it better?
+- Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
+- If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
+- If the ticket is a feature request, do you agree with it, and could the feature request instead be implemented as a third party package?
Development
-
-- git clone & PYTHONPATH
-- Pep8
-- Recommend editor that runs pep8
-
-Pull requests
-
-- Make pull requests early
-- Describe branching
-
-Managing compatibility issues
-
-- Describe compat module
-
-Testing
-
-- Running the tests
-- tox
-
+To start developing on Django REST framework, clone the repo:
+git clone git@github.com:tomchristie/django-rest-framework.git
+
+Changes should broadly follow the PEP 8 style conventions, and we recommend you setup your editor to automatically indicated non-conforming styles.
+Testing
+To run the tests, clone the repository, and then:
+# Setup the virtual environment
+virtualenv env
+env/bin/activate
+pip install -r requirements.txt
+pip install -r optionals.txt
+
+# Run the tests
+rest_framework/runtests/runtests.py
+
+You can also use the excellent [tox][tox] testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:
+tox
+
+Pull requests
+It's a good idea to make pull requests early on. A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.
+It's also always best to make a new branch before starting work on a pull request. This means that you'll be able to later switch back to working on another seperate issue without interfering with an ongoing pull requests.
+It's also useful to remember that if you have an outstanding pull request then pushing new commits to your GitHub repo will also automatically update the pull requests.
+GitHub's documentation for working on pull requests is available here.
+Always run the tests before submitting pull requests, and ideally run tox in order to check that your modifications are compatible with both Python 2 and Python 3, and that they run properly on all supported versions of Django.
+Once you've made a pull request take a look at the travis build status in the GitHub interface and make sure the tests are runnning as you'd expect.
+
+Above: Travis build notifications
+Managing compatibility issues
+Sometimes, in order to ensure your code works on various different versions of Django, Python or third party libraries, you'll need to run slightly different code depending on the environment. Any code that branches in this way should be isolated into the compat.py module, and should provide a single common interface that the rest of the codebase can use.
Documentation
The documentation for REST framework is built from the Markdown source files in the docs directory.
There are many great markdown editors that make working with the documentation really easy. The Mou editor for Mac is one such editor that comes highly recommended.
@@ -270,7 +290,7 @@
- Keep paragraphs reasonably short.
- Use double spacing after the end of sentences.
-- Don't use the abbreviations such as 'e.g..' but instead use long form, such as 'For example'.
+- Don't use the abbreviations such as 'e.g.' but instead use long form, such as 'For example'.
Markdown style
There are a couple of conventions you should follow when working on the documentation.
@@ -299,19 +319,10 @@ More text...
If you want to draw attention to a note or warning, use a pair of enclosing lines, like so:
---
-**Note:** Make sure you do this thing.
+**Note:** A useful documentation note.
---
-Third party packages
-
-- Django reusable app
-
-Core committers
-
-- Still use pull reqs
-- Credits
-
diff --git a/topics/credits.html b/topics/credits.html
index f0086c58c..1991f1e21 100644
--- a/topics/credits.html
+++ b/topics/credits.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -381,6 +382,7 @@
Yamila Moreno - yamila-moreno
Rob Hudson - robhudson
Alex Good - alexjg
+Ian Foote - ian-foote
Many thanks to everyone who's contributed to the project.
Additional thanks
diff --git a/topics/documenting-your-api.html b/topics/documenting-your-api.html
index b622c0edb..22cec3607 100644
--- a/topics/documenting-your-api.html
+++ b/topics/documenting-your-api.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
diff --git a/topics/release-notes.html b/topics/release-notes.html
index f7ae55a24..6c205ab25 100644
--- a/topics/release-notes.html
+++ b/topics/release-notes.html
@@ -102,6 +102,7 @@
Browser enhancements
The Browsable API
REST, Hypermedia & HATEOAS
+ Contributing to REST framework
2.0 Announcement
2.2 Announcement
2.3 Announcement
@@ -243,6 +244,13 @@
2.3.x series
+Master
+
+- Add in choices information for ChoiceFields in response to
OPTIONS requests.
+- Added
pre_delete() and post_delete() method hooks.
+- Bugfix: Responses without any content no longer include an HTTP
'Content-Type' header.
+- Bugfix: Correctly handle validation errors in PUT-as-create case, responding with 400.
+
2.3.9
Date: 15th November 2013
diff --git a/topics/rest-framework-2-announcement.html b/topics/rest-framework-2-announcement.html
index 4cf7f9800..829d60fcf 100644
--- a/topics/rest-framework-2-announcement.html
+++ b/topics/rest-framework-2-announcement.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html
index 899e3b868..4fd86ecca 100644
--- a/topics/rest-hypermedia-hateoas.html
+++ b/topics/rest-hypermedia-hateoas.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/topics/writable-nested-serializers.html b/topics/writable-nested-serializers.html
index b7d535cad..f6a426ae2 100644
--- a/topics/writable-nested-serializers.html
+++ b/topics/writable-nested-serializers.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html
index 8028f27ab..4daaf9d44 100644
--- a/tutorial/1-serialization.html
+++ b/tutorial/1-serialization.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html
index fe084a554..69d3d3dd0 100644
--- a/tutorial/2-requests-and-responses.html
+++ b/tutorial/2-requests-and-responses.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html
index d4a14f113..a802cf736 100644
--- a/tutorial/3-class-based-views.html
+++ b/tutorial/3-class-based-views.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/4-authentication-and-permissions.html b/tutorial/4-authentication-and-permissions.html
index bde22d77d..b4b6c57be 100644
--- a/tutorial/4-authentication-and-permissions.html
+++ b/tutorial/4-authentication-and-permissions.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html
index 68bf60f7c..7a7f767ef 100644
--- a/tutorial/5-relationships-and-hyperlinked-apis.html
+++ b/tutorial/5-relationships-and-hyperlinked-apis.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/6-viewsets-and-routers.html b/tutorial/6-viewsets-and-routers.html
index 6dd440291..111d699ae 100644
--- a/tutorial/6-viewsets-and-routers.html
+++ b/tutorial/6-viewsets-and-routers.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement
diff --git a/tutorial/quickstart.html b/tutorial/quickstart.html
index 9f50bba0c..70fef44c3 100644
--- a/tutorial/quickstart.html
+++ b/tutorial/quickstart.html
@@ -102,6 +102,7 @@
- Browser enhancements
- The Browsable API
- REST, Hypermedia & HATEOAS
+ - Contributing to REST framework
- 2.0 Announcement
- 2.2 Announcement
- 2.3 Announcement