requests-oauth 0.4.1

# requests-oauth

此插件为 <a href="https://github.com/kennethreitz" rel="nofollow">@kennethreitz</a> 众所周知的 <a href="http://github.com/kennethreitz/requests" rel="nofollow">requests</a> 库添加OAuth v1.0支持，提供头部和URL编码的认证。

requests-oauth希望建立最简单、最直接的Python OAuth实现方式。它最初基于 <a href="https://github.com/simplegeo/python-oauth2" rel="nofollow">python-oauth2</a>（看起来未维护），感谢作者和贡献者为提供OAuth至python httplib2所做的巨大努力。从那时起，代码库已得到清理，修复了几个错误，并进行了大量重构以消除与python-oauth2的依赖，现在成为一个独立的插件。

• 作者： <a href="http://www.github.com/maraujop/" rel="nofollow">Miguel Araujo</a>

• 许可证： BSD

## 安装

您可以通过以下方式安装requests-oauth

pip install requests-oauth

## 使用

导入钩子执行

from oauth_hook import OAuthHook

您可以通过传递5个参数来初始化钩子：access_token、access_token_secret、consumer_key、consumer_secret和header_auth。前两个access_token和access_token_secret是可选的，如果您想从API服务中获取这些信息（稍后示例中说明）。初始化钩子有两种方式。第一种

oauth_hook = OAuthHook(access_token, access_token_secret, consumer_key, consumer_secret, header_auth)

header_auth参数让您选择使用的认证方法。它是一个布尔值，如果您将其设置为True，则将使用授权头。如果您的API支持此认证方法，则应使用此方法，这是OAuth规范推荐的方法（<a href="http://tools.ietf.org/html/rfc5849#section-3.5" rel="nofollow">http://tools.ietf.org/html/rfc5849#section-3.5</a>），例如Twitter的API。默认情况下，header_auth设置为False，这意味着将使用URL编码认证。这是因为这是最广泛支持的认证系统。

如果您一直使用相同的consumer_key和consumer_secret，您可能希望设置这些固定值，这样您就只需要传递用于设置钩子的令牌参数。

OAuthHook.consumer_key = consumer_key OAuthHook.consumer_secret = consumer_secret oauth_hook = OAuthHook(access_token, access_token_secret, header_auth=True)

现在您需要将钩子传递给python-requests，您可能希望将其作为一个会话来完成，这样您就不必每次都这样做。

client = requests.session(hooks={'pre_request': oauth_hook})

您得到的是python-requests客户端，您可以像使用requests API一样使用它。让我们看看一个GET示例

response = client.get('

response = client.post('

imgur_oauth_hook = OAuthHook(consumer_key=YOUR_IMGUR_CONSUMER_KEY, consumer_secret=YOUR_IMGUR_CONSUMER_SECRET) response = requests.post('

print “Go to

new_imgur_oauth_hook = OAuthHook(oauth_token, oauth_secret, IMGUR_CONSUMER_KEY, IMGUR_CONSUMER_SECRET) 响应 = requests.post(‘http://api.imgur.com/oauth/access_token’， {‘oauth_verifier’: oauth_verifier}, hooks={‘pre_request’: new_imgur_oauth_hook}) 响应 = parse_qs(响应.content) final_token = 响应[‘oauth_token’][0] final_token_secret = 响应[‘oauth_token_secret’][0]

这些 final_token 和 final_token_secret 是我们处理用户OAuth所需凭据，因此您可能需要以某种方式持久化它们。这些是在构建带有新钩子的请求会话时应使用的凭据。请注意，并非所有OAuth API都提供无限期的凭据。

## 测试

如果您想运行测试，需要将 test_settings.py.template 复制到 test_settings.py。此文件在 .gitignore 索引中，因此不会被提交

cp test_settings.py.template test_settings.py

然后填写那里的信息。该库的测试是通过功能方式进行的，对公共OAuth API（如Twitter）进行GET和POST操作，因此请使用测试账户而不是您的个人账户

./tests.py

## 贡献

如果您想贡献，请简单地将存储库Fork，将更改提交到 dev 分支（或从中分支），然后发送拉取请求。确保您已将自己在 AUTHORS 中添加。