| OLD | NEW |
| (Empty) |
| 1 .. Requests documentation master file, created by | |
| 2 sphinx-quickstart on Sun Feb 13 23:54:25 2011. | |
| 3 You can adapt this file completely to your liking, but it should at least | |
| 4 contain the root `toctree` directive. | |
| 5 | |
| 6 Requests: HTTP for Humans | |
| 7 ========================= | |
| 8 | |
| 9 Release v\ |version|. (:ref:`Installation <install>`) | |
| 10 | |
| 11 Requests is the only *Non-GMO* HTTP library for Python, safe for human | |
| 12 consumption. | |
| 13 | |
| 14 **Warning:** Recreational use of other HTTP libraries may result in dangerous si
de-effects, | |
| 15 including: security vulnerabilities, verbose code, reinventing the wheel, | |
| 16 constantly reading documentation, depression, headaches, or even death. | |
| 17 | |
| 18 Behold, the power of Requests:: | |
| 19 | |
| 20 >>> r = requests.get('https://api.github.com/user', auth=('user', 'pass')) | |
| 21 >>> r.status_code | |
| 22 200 | |
| 23 >>> r.headers['content-type'] | |
| 24 'application/json; charset=utf8' | |
| 25 >>> r.encoding | |
| 26 'utf-8' | |
| 27 >>> r.text | |
| 28 u'{"type":"User"...' | |
| 29 >>> r.json() | |
| 30 {u'private_gists': 419, u'total_private_repos': 77, ...} | |
| 31 | |
| 32 See `similar code, sans Requests <https://gist.github.com/973705>`_. | |
| 33 | |
| 34 | |
| 35 Requests allows you to send *organic, grass-fed* HTTP/1.1 requests, without the | |
| 36 need for manual labor. There's no need to manually add query strings to your | |
| 37 URLs, or to form-encode your POST data. Keep-alive and HTTP connection pooling | |
| 38 are 100% automatic, powered by `urllib3 <https://github.com/shazow/urllib3>`_, | |
| 39 which is embedded within Requests. | |
| 40 | |
| 41 User Testimonials | |
| 42 ----------------- | |
| 43 | |
| 44 Her Majesty's Government, Amazon, Google, Twilio, Runscope, Mozilla, Heroku, | |
| 45 PayPal, NPR, Obama for America, Transifex, Native Instruments, The Washington | |
| 46 Post, Twitter, SoundCloud, Kippt, Readability, Sony, and Federal U.S. | |
| 47 Institutions that prefer to be unnamed claim to use Requests internally. | |
| 48 | |
| 49 **Armin Ronacher** | |
| 50 Requests is the perfect example how beautiful an API can be with the | |
| 51 right level of abstraction. | |
| 52 | |
| 53 **Matt DeBoard** | |
| 54 I'm going to get @kennethreitz's Python requests module tattooed | |
| 55 on my body, somehow. The whole thing. | |
| 56 | |
| 57 **Daniel Greenfeld** | |
| 58 Nuked a 1200 LOC spaghetti code library with 10 lines of code thanks to | |
| 59 @kennethreitz's request library. Today has been AWESOME. | |
| 60 | |
| 61 **Kenny Meyers** | |
| 62 Python HTTP: When in doubt, or when not in doubt, use Requests. Beautiful, | |
| 63 simple, Pythonic. | |
| 64 | |
| 65 Requests is one of the most downloaded Python packages of all time, pulling in | |
| 66 over 7,000,000 downloads every month. All the cool kids are doing it! | |
| 67 | |
| 68 Supported Features | |
| 69 ------------------ | |
| 70 | |
| 71 Requests is ready for today's web. | |
| 72 | |
| 73 - International Domains and URLs | |
| 74 - Keep-Alive & Connection Pooling | |
| 75 - Sessions with Cookie Persistence | |
| 76 - Browser-style SSL Verification | |
| 77 - Basic/Digest Authentication | |
| 78 - Elegant Key/Value Cookies | |
| 79 - Automatic Decompression | |
| 80 - Automatic Content Decoding | |
| 81 - Unicode Response Bodies | |
| 82 - Multipart File Uploads | |
| 83 - HTTP(S) Proxy Support | |
| 84 - Connection Timeouts | |
| 85 - Streaming Downloads | |
| 86 - ``.netrc`` Support | |
| 87 - Chunked Requests | |
| 88 - Thread-safety | |
| 89 | |
| 90 Requests supports Python 2.6 — 3.5, and runs great on PyPy. | |
| 91 | |
| 92 | |
| 93 The User Guide | |
| 94 -------------- | |
| 95 | |
| 96 This part of the documentation, which is mostly prose, begins with some | |
| 97 background information about Requests, then focuses on step-by-step | |
| 98 instructions for getting the most out of Requests. | |
| 99 | |
| 100 .. toctree:: | |
| 101 :maxdepth: 2 | |
| 102 | |
| 103 user/intro | |
| 104 user/install | |
| 105 user/quickstart | |
| 106 user/advanced | |
| 107 user/authentication | |
| 108 | |
| 109 | |
| 110 The Community Guide | |
| 111 ------------------- | |
| 112 | |
| 113 This part of the documentation, which is mostly prose, details the | |
| 114 Requests ecosystem and community. | |
| 115 | |
| 116 .. toctree:: | |
| 117 :maxdepth: 1 | |
| 118 | |
| 119 community/faq | |
| 120 community/recommended | |
| 121 community/out-there | |
| 122 community/support | |
| 123 community/vulnerabilities | |
| 124 community/updates | |
| 125 community/release-process | |
| 126 | |
| 127 The API Documentation / Guide | |
| 128 ----------------------------- | |
| 129 | |
| 130 If you are looking for information on a specific function, class, or method, | |
| 131 this part of the documentation is for you. | |
| 132 | |
| 133 .. toctree:: | |
| 134 :maxdepth: 2 | |
| 135 | |
| 136 api | |
| 137 | |
| 138 | |
| 139 The Contributor Guide | |
| 140 --------------------- | |
| 141 | |
| 142 If you want to contribute to the project, this part of the documentation is for | |
| 143 you. | |
| 144 | |
| 145 .. toctree:: | |
| 146 :maxdepth: 3 | |
| 147 | |
| 148 dev/contributing | |
| 149 dev/philosophy | |
| 150 dev/todo | |
| 151 dev/authors | |
| 152 | |
| 153 There are no more guides. You are now guideless. | |
| 154 Good luck. | |
| OLD | NEW |