encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-25 19:14:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Created REST framework 2 roadmap (markdown)

tomchristie 2013-01-03 13:20:51 -08:00
parent d5b7e45e5a
commit 46ee29f021
1 changed files with 64 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
REST-framework-2-roadmap.md Normal file

@ -0,0 +1,64 @@
# REST framework 2 roadmap
## General synopsis.
Firstly, and above all, thank you. I've been amazed with the response to 2.0, and I'm incredibly happy with the little community we're starting to build here. I think we've got an absolutely rock-solid set of foundations now, and I'm really looking forward to helping the project mature into a world-class API framework. Again, thank you for all the incredible help in getting to this point.
## Overall goals.
I guess the big picture here is taking this from a pet-project into a community-owned effort.
* I'm going to try to be liberal in handing out the commit-bit.
* If there's anything you think I ought to be doing differently in terms of how we run this project please feel free to chime in - I don't have a problem with constructive criticism.
* Any ideas on how to help make the project more community-owned are appreciated. (Maybe consider moving to a github organization repo?)
* I'd like to do everything I can to encourage third-party maintained add-ons (eg. custom serializers, filtering backends, auth, throttling etc.) Keeping the maintenance cost of the project down is going to be one thing that really helps it stay healthy in the long term.
* In terms of project maintenance, going to continue to focus on keeping that issues list well under control, and be ruthless in keeping the core API simple & clean.
* I'd really like to run sprints at DjangoCon Europe and (maybe, maybe) DjangoCon US (at the very least I'll try to help do something remotely). If you have an employer who might pay your conference ticket, the start of the year would be a really good time to talk to them, so start thinking about it now.
## Milestones.
The following are the major features I'd like to see added to the framework.
### Py3k support.
Coming along very nicely, thanks to @xordoquy. See [#464].
### Writable nested serializers.
Currently being tackled by @maspwr. See [#536], and related tickets. This is a tough one. I reckon we could probably split of some parts of this if anyone also wants to work on it. (Eg. at some point we'll need to think about complex stuff like how we deal with rendering serializers as nested HTML forms.)
### OAuth.
Speaks for itself. This really shouldn't be hard, just needs a little legwork - someone needs to make the time to get it done, tested and nicely documented. See [#8].
### RawFileUpload parser.
Not sure if this should be a milestone or not, but feels like a really nice feature to me. See [#7] for details. (Yes it really is that old.)
### HTMLFormRenderer.
Support for rendering serializers directly into HTML. Kind of supported via the browseable API, but it'd be nice to be able to directly render them into an HTML form, without the convert-to-a-Form-object-first approach that's currently used. Shouldn't be tricky, and would be rather nice. See [#310].
### Resources & routers.
See [resources-routers] branch. Automatic URL routing and resource registering, as per Rails, Tastypie & Dagny. The design work is basically done, so if anyone wants to pick this up we can work on it together. Will require a bit of code and a big chunk of documentation, plus an extra section in the tutorial. This has been put off a couple of times in the past as I wasn't happy with the fundamentals, but I think there's a really nice design now, and I think I'd be happy for it to go it.
### GET forms in browseable API.
When a filter backend is configured for a view, provide an HTML form for it in the browseable API. I think django-filter does almost all of what we need for that already, so just a case of tying into that, making it work okay with the bootstrap theme, and documenting it a little.
### ...and other nice to haves.
For example:
* Proper authenticate responses
* CSV Support
* Digest authentication
[#7]: https://github.com/tomchristie/django-rest-framework/pull/7
[#8]: https://github.com/tomchristie/django-rest-framework/pull/8
[#310]: https://github.com/tomchristie/django-rest-framework/pull/310
[#464]: https://github.com/tomchristie/django-rest-framework/pull/464
[#536]: https://github.com/tomchristie/django-rest-framework/pull/536
[resources-routers]: https://github.com/tomchristie/django-rest-framework/tree/resources-routers