search

encode / django-rest-framework

Web APIs for Django. 🎸
https://www.django-rest-framework.org
Other
28.13k stars 6.8k forks source link

Consider using httpie for examples. #2068

Closed tomchristie closed 9 years ago

tomchristie commented 9 years ago

Nicer and more usable than curl.

https://github.com/jakubroztocil/httpie

xordoquy commented 9 years ago

However, it's more likely to have curl installed on the system.

tomchristie commented 9 years ago

True, pip install httpie is pretty easy, but fair point. Let's treat this as "for consideration" rather than a given.

thedrow commented 9 years ago

httpie also has a package for Debian/Ubuntu.

xordoquy commented 9 years ago

Right, I'm fine with httpie given DRF is a python project as well and provided we give some direction about installing it - in particular for windows. Having it package for Debian/Ubuntu is a good thing but there are a lot of other distributions and OS out there.

thedrow commented 9 years ago

It's also packaged for Fedora but not CentOS.

phalt commented 9 years ago

I've worked on this today for the 24pullrequests, in case you want to merge it later on after a decision is made.

Httpie has replaced all the examples in:

The Quickstart and tutorial sections also help users install it, and give reasons why they should use it.

I decided not to replace the curl examples on the authentication pages. This is because httpie only supports basic and digest authentication unless you install extra things, which would just take too much time for the user and detract from the purpose of the documentation.

See PR #2165

maryokhin commented 9 years ago

Don't know what you decide for the tutorial, but thanks to this issue I discovered the awesome httpie package for myself :)