Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pr/toph tab/23 #24

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\docs"
}
77 changes: 28 additions & 49 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Requests: 让 HTTP 服务人类
============================

发行版本 v\ |version|. (:ref:`安装说明 <install>`)

.. image:: https://img.shields.io/pypi/l/requests.svg
:target: https://pypi.python.org/pypi/requests

Expand All @@ -24,13 +23,11 @@ Requests: 让 HTTP 服务人类
.. image:: https://img.shields.io/badge/Say%20Thanks!-🦉-1EAEDB.svg
:target: https://saythanks.io/to/kennethreitz

Requests 唯一的一个\ **非转基因**\的 Python HTTP 库,人类可以安全享用。

**警告**:非专业使用其他 HTTP 库会导致危险的副作用,包括:安全缺陷症、冗余代码症、重新发明轮子\
症、啃文档症、抑郁、头疼、甚至死亡。
**Requests** 一个优雅、简单的 Python HTTP 库,为人类所建。

看吧,这就是 Requests 的威力:
::
-------------------
**看吧,Requests的力量**::

>>> r = requests.get('https://api.github.com/user', auth=('user', 'pass'))
>>> r.status_code
Expand All @@ -40,50 +37,29 @@ Requests 唯一的一个\ **非转基因**\的 Python HTTP 库,人类可以安
>>> r.encoding
'utf-8'
>>> r.text
u'{"type":"User"...'
'{"type":"User"...'
>>> r.json()
{u'private_gists': 419, u'total_private_repos': 77, ...}
{'private_gists': 419, 'total_private_repos': 77, ...}

参见 `未使用 Requests 的相似代码 <https://gist.github.com/973705>`_.

Requests 允许你发送\ **纯天然,植物饲养**\的 HTTP/1.1 请求,无需手工劳动。你不需要手动为
URL 添加查询字串,也不需要对 POST 数据进行表单编码。Keep-alive 和 HTTP 连接池的功能是
100% 自动化的,一切动力都来自于根植在 Requests 内部的 `urllib3 <https://github.com/shazow/urllib3>`_。

用户见证
------------

Twitter、Spotify、Microsoft、Amazon、Lyft、BuzzFeed、Reddit、NSA、女王殿下的政府、\
Amazon、Google、Twilio、Mozilla、Heroku、PayPal、NPR、Obama for America、\
Transifex、Native Instruments、Washington Post、Twitter、SoundCloud、Kippt、Readability、\
以及若干不愿公开身份的联邦政府机构都在内部使用。

**Armin Ronacher**
Requests 是一个完美的例子,它证明了通过恰到好处的抽象,API 可以写得多么优美。

**Matt DeBoard**
我要想个办法,把 @kennethreitz 写的 Python requests 模块做成纹身。一字不漏。

**Daniel Greenfeld**
感谢 @kennethreitz 的 Requests 库,刚刚用 10 行代码炸掉了 1200 行意大利面代码。\
今天真是爽呆了!

**Kenny Meyers**
Python HTTP: 疑惑与否,都去用 Requests 吧。简单优美,而且符合 Python 风格。

**Requests** 允许你极其简单地发送 HTTP/1.1 请求。
你不需要手动为URL 添加查询字符串(quering string),也不需要对 POST 数据进行form-encode。
Keep-alive 和 HTTP 连接池的功能是100% 自动化的,感谢 `urllib3 <https://github.com/shazow/urllib3>`_。

功能特性
---------------

Requests 完全满足今日 web 的需求
Requests 准备好面对现在的互联网

- Keep-Alive & 连接池
- 国际化域名和 URL
- 带持久 Cookie 的会话
- 浏览器式的 SSL 认证
- 自动内容解码
- 国际域名和 URLs
- 持久的带 Cookie 的Session
- 浏览器式 SSL 认证
- 自动化内容解码
- 基本/摘要式的身份认证
- 优雅的 key/value Cookie
- 优雅的 key/value Cookies
- 自动解压
- Unicode 响应体
- HTTP(S) 代理支持
Expand All @@ -92,39 +68,43 @@ Requests 完全满足今日 web 的需求。
- 连接超时
- 分块请求
- 支持 ``.netrc``

Requests 官方支持 Python 2.7和3.5以上版本,而且能在 PyPy 下良好运行。

Requests 支持 Python 2.6—2.7以及3.3—3.7,而且能在 PyPy 下完美运行。

用户指南
----------

这部分文档是以文字为主,从 Requests 的背景讲起,然后对 Requests 的重点功能做了逐一的介绍。
这部分文档是以文字为主,从 Requests 的背景信息讲起,然后对 Requests 的重点功能做了逐一的介绍。

.. toctree::
:maxdepth: 2

user/intro
user/install
user/quickstart
user/advanced
user/authentication

社区指南
----------
-------

这部分文档也是文字为主,详细介绍了 Requests 的生态和社区。

.. toctree::
:maxdepth: 1
:maxdepth: 2

community/faq
community/recommended
community/faq
community/out-there
community/support
community/vulnerabilities
community/updates
community/release-process

.. toctree::
:maxdepth: 1

community/updates

API 文档/指南
----------------

Expand All @@ -135,17 +115,16 @@ API 文档/指南

api

贡献指南
贡献者指南
---------

如果你要为项目做出贡献,请参考这部分文档
如果你要为项目做贡献,这部分文档就是为你准备的

.. toctree::
:maxdepth: 3

dev/contributing
dev/philosophy
dev/todo

dev/authors

没有别的指南了,你现在要靠自己了。
Expand Down
31 changes: 13 additions & 18 deletions docs/user/install.rst
Original file line number Diff line number Diff line change
@@ -1,41 +1,36 @@
.. _install:

安装 Requests
==============
=============

这部分文档包含了 Requests 的安装过程,使用任何软件的第一步就是正确地安装它。
这部分文档包含了 Requests 的安装过程。
使用任何软件的第一步是正确地安装它。


pip install requests
---------------------
$ python -m pip install requests
--------------------------------

要安装 Requests,只要在你的终端中运行这个简单命令即可:

::
$ pip install requests

如果你没有安装 pip (啧啧),这个 `Python installation guide <http://docs.python-guide.org/en/latest/starting/installation/>`_
可以带你完成这一流程。
要安装 Requests,只要在你的终端中运行这个简单命令即可::

$ python -m pip install requests

获得源码
------------
-------

Requests 一直在 Github 上积极地开发,你可以一直从\
`这里 <https://github.com/requests/requests>`_\获取到代码。
`这里 <https://github.com/psf/requests>`_\获取到代码。

你可以克隆公共版本库:

::
你可以克隆公共版本库::

git clone git://github.com/kennethreitz/requests.git
$ git clone git://github.com/psf/requests.git

也可以下载 `tarball <https://github.com/requests/requests/tarball/master>`_::

$ curl -OL https://github.com/requests/requests/tarball/master
$ curl -OL https://github.com/psf/requests/tarball/master
# Windows 用户也可选择 zip 包

获得代码之后,你就可以轻松的将它嵌入到你的 python 包里,或者安装到你的 site-packages::

$ cd requests
$ pip install .
$ python -m pip install .
41 changes: 0 additions & 41 deletions docs/user/intro.rst

This file was deleted.

Loading