DESCRIPTION.rst 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <span align="center">
  2. <pre>
  3. <a href="https://requests.readthedocs.io/"><img src="https://raw.githubusercontent.com/psf/requests/master/ext/requests-logo.png" align="center" /></a>
  4. <div align="left">
  5. <p></p>
  6. <code> Python 3.7.4 (default, Sep 7 2019, 18:27:02)</code>
  7. <code> >>> <strong>import requests</strong></code>
  8. <code> >>> r = requests.get('https://api.github.com/repos/psf/requests')</code>
  9. <code> >>> r.json()["description"]</code>
  10. <code> 'A simple, yet elegant HTTP library.'</code>
  11. </div>
  12. <p>
  13. This software has been designed for you, with much joy,
  14. by <a href="https://kennethreitz.org/">Kenneth Reitz</a> &
  15. is protected by The <a href="https://www.python.org/psf/">Python Software Foundation</a>.
  16. </p>
  17. </pre>
  18. </span>
  19. <p>&nbsp;</p><p>&nbsp;</p>
  20. <p align="center"><strong>Requests</strong> is an elegant and simple HTTP library for Python, built with ♥.</p>
  21. <p>&nbsp;</p>
  22. ```python
  23. >>> import requests
  24. >>> r = requests.get('https://api.github.com/user', auth=('user', 'pass'))
  25. >>> r.status_code
  26. 200
  27. >>> r.headers['content-type']
  28. 'application/json; charset=utf8'
  29. >>> r.encoding
  30. 'utf-8'
  31. >>> r.text
  32. '{"type":"User"...'
  33. >>> r.json()
  34. {'disk_usage': 368627, 'private_gists': 484, ...}
  35. ```
  36. ---------------------------------------------------------------------
  37. <p>&nbsp;</p>
  38. Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your `PUT` & `POST` data — but nowadays, just use the `json` method!
  39. Requests is one of the most downloaded Python package today, pulling in around `14M downloads / week`— according to GitHub, Requests is currently [depended upon](https://github.com/psf/requests/network/dependents?package_id=UGFja2FnZS01NzA4OTExNg%3D%3D) by `500,000+` repositories. You may certainly put your trust in this code.
  40. <p>&nbsp;</p>
  41. <p align="center"><a href="https://pepy.tech/project/requests" rel="nofollow"><img src="https://camo.githubusercontent.com/e1dedc9f5ce5cd6b6c699f33d2e812daadcf3645/68747470733a2f2f706570792e746563682f62616467652f7265717565737473" alt="Downloads" data-canonical-src="https://pepy.tech/badge/requests" style="max-width:100%;"></a>
  42. <a href="https://pypi.org/project/requests/" rel="nofollow"><img src="https://camo.githubusercontent.com/6d78aeec0a9a1cfe147ad064bfb99069e298e29b/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f72657175657374732e737667" alt="image" data-canonical-src="https://img.shields.io/pypi/pyversions/requests.svg" style="max-width:100%;"></a>
  43. <a href="https://github.com/psf/requests/graphs/contributors"><img src="https://camo.githubusercontent.com/a70ea15870b38bba9203b969f6a6b7e7845fbb8a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f7073662f72657175657374732e737667" alt="image" data-canonical-src="https://img.shields.io/github/contributors/psf/requests.svg" style="max-width:100%;"></a></p>
  44. <p>&nbsp;</p>
  45. <h2 align="center">Supported Features & Best–Practices</h2>
  46. Requests is ready for the demands of building robust and reliable HTTP–speak applications, for the needs of today.
  47. <pre class="test">
  48. + International Domains and URLs + Keep-Alive & Connection Pooling
  49. + Sessions with Cookie Persistence + Browser-style SSL Verification
  50. + Basic & Digest Authentication + Familiar `dict`–like Cookies
  51. + Automatic Decompression of Content + Automatic Content Decoding
  52. + Automatic Connection Pooling + Unicode Response Bodies<super>*</super>
  53. + Multi-part File Uploads + SOCKS Proxy Support
  54. + Connection Timeouts + Streaming Downloads
  55. + Automatic honoring of `.netrc` + Chunked HTTP Requests
  56. &, of course, rock–solid stability!
  57. </pre>
  58. </div>
  59. <p align="center">
  60. ✨ 🍰 ✨&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  61. </p>
  62. <p>&nbsp;</p>
  63. Requests Module Installation
  64. ----------------------------
  65. The recommended way to install the `requests` module is to simply use [`pipenv`](https://pipenv.kennethreitz.org) (or `pip`, of
  66. course):
  67. ```console
  68. $ pipenv install requests
  69. Adding requests to Pipfile's [packages]…
  70. ✔ Installation Succeeded
  71. ```
  72. Requests officially supports Python 2.7 & 3.5+.
  73. -------------------------------------
  74. ## P.S. — Documentation is available at [`requests.readthedocs.io`](https://requests.readthedocs.io/en/latest/).
  75. <p align="center">
  76. <a href="https://requests.readthedocs.io/"><img src="https://raw.githubusercontent.com/psf/requests/master/ext/ss.png" align="center" /></a>
  77. </p>
  78. ------------------
  79. <p>&nbsp;</p>
  80. <p align="center">
  81. <a href="https://kennethreitz.org/"><img src="https://raw.githubusercontent.com/psf/requests/master/ext/kr.png" align="center" /></a>
  82. </p>
  83. <p>&nbsp;</p>
  84. <p align="center">
  85. <a href="https://www.python.org/psf/"><img src="https://raw.githubusercontent.com/psf/requests/master/ext/psf.png" align="center" /></a>
  86. </p>