From 533c384b875166eef837b4e0e45125cf8ad9c6b1 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Sat, 1 Aug 2020 19:50:53 -0500 Subject: [PATCH] Make README markdown compatible --- README.md | 118 +++++++++++++----------------------------------------- 1 file changed, 27 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index f3b1eebf..9ba56216 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,6 @@ +# Requests - - - -
-    
-    
-    

-    

-     Python 3.7.4 (default, Sep  7 2019, 18:27:02)
-     >>> import requests
-     >>> r = requests.get('https://api.github.com/repos/psf/requests')
-     >>> r.json()["description"]
-     'A simple, yet elegant HTTP library.'
-    

-
-    

-This software has been designed for you, with much joy,
-by Kenneth Reitz & is protected by The Python Software Foundation.
-   

-
- - - -

 

 

- -

Requests is an elegant and simple HTTP library for Python, built with ♥.

- -

 

+**Requests** is a simple, yet elegant HTTP library. ```python >>> import requests @@ -43,84 +17,46 @@ by Kenneth Reitz & is protected by The < {'disk_usage': 368627, 'private_gists': 484, ...} ``` - - ---------------------------------------------------------------------- - -

 

- 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! - 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. +[![Downloads](https://pepy.tech/badge/requests)](https://pepy.tech/project/requests) +[![Supported Versions](https://img.shields.io/pypi/pyversions/requests.svg)](https://pypi.org/project/requests) +[![Contributors](https://img.shields.io/github/contributors/psf/requests.svg)](https://github.com/psf/requests/graphs/contributors) -

 

-

Downloads -image -image

+## Installing Requests and Supported Versions -

 

- -

Supported Features & Best–Practices

- -Requests is ready for the demands of building robust and reliable HTTP–speak applications, for the needs of today. - -
-         + International Domains and URLs       + Keep-Alive & Connection Pooling
-         + Sessions with Cookie Persistence     + Browser-style SSL Verification
-         + Basic & Digest Authentication        + Familiar `dict`–like Cookies
-         + Automatic Decompression of Content   + Automatic Content Decoding
-         + Automatic Connection Pooling         + Unicode Response Bodies*
-         + Multi-part File Uploads              + SOCKS Proxy Support
-         + Connection Timeouts                  + Streaming Downloads
-         + Automatic honoring of `.netrc`       + Chunked HTTP Requests
-
-                            &, of course, rock–solid stability!
-
- - -

- ✨ 🍰 ✨             -

- -

 

- -Requests Module Installation ----------------------------- - -The recommended way to install the `requests` module is to simply use [`pipenv`](https://pipenv.kennethreitz.org) (or `pip`, of -course): +Requests is available on PyPI: ```console -$ pipenv install requests -Adding requests to Pipfile's [packages]… -✔ Installation Succeeded -… +$ python -m pip install requests ``` Requests officially supports Python 2.7 & 3.5+. -------------------------------------- +## Supported Features & Best–Practices -## P.S. — Documentation is available at [`requests.readthedocs.io`](https://requests.readthedocs.io/en/latest/). +Requests is ready for the demands of building robust and reliable HTTP–speaking applications, for the needs of today. -

- -

+- Keep-Alive & Connection Pooling +- International Domains and URLs +- Sessions with Cookie Persistence +- Browser-style TLS/SSL Verification +- Basic & Digest Authentication +- Familiar `dict`–like Cookies +- Automatic Content Decompression and Decoding +- Multi-part File Uploads +- SOCKS Proxy Support +- Connection Timeouts +- Streaming Downloads +- Automatic honoring of `.netrc` +- Chunked HTTP Requests +## API Reference and User Guide available on [Read the Docs](https://requests.readthedocs.io) ------------------- +[![Read the Docs](https://raw.githubusercontent.com/psf/requests/master/ext/ss.png)](https://requests.readthedocs.io) +--- -

 

- -

- -

- -

 

- -

- -

+[![Kenneth Reitz](https://raw.githubusercontent.com/psf/requests/master/ext/kr.png)](https://kennethreitz.org) [![Python Software Foundation](https://raw.githubusercontent.com/psf/requests/master/ext/psf.png)](https://www.python.org/psf)