pyshk 1.1.0

安装

使用安装

pip install pyshk

为了开始，你必须注册mlkshk（耶！）并在mlkshk.com上创建应用程序。首先，您需要在这里注册一个帐户：http://mlkshk.com/create-account。

然后，创建我们将创建一个应用程序，以便您可以使用api。你应该在http://mlkshk.com/developers/new-api-application做。给你的申请一个标题和描述。请务必填写“重定向url”，因为我们稍后将使用它。在mlkshk.com和您的代码中，重定向url必须完全相同，否则当您尝试进行身份验证时，服务器将返回500服务器错误。

一旦你点击大“创建它！按钮，你将得到一个“钥匙”和一个“秘密”。把这些写下来。我们以后需要它们。

用法

启动python解释器，然后导入api:

from pyshk.api import Api

如果您没有访问令牌（如果这是第一次运行，则不会），请使用上面的密钥和机密启动api：

a = Api(consumer_key=[Key], consumer_secret=[Secret])
a.get_auth(redirect_uri=[the redirect url from above])

此时，您的Web浏览器将打开，并提示您允许应用程序（无论您如何命名）访问您的帐户。允许应用程序访问，您将被重定向到创建应用程序时指定的任何重定向URL。url栏将包含类似http://[redirect_url]?code=[code]的内容。将[code]部分复制并粘贴回python解释器，然后按enter键。然后，您将获得访问代码和访问机密；您应该将它们写下来，这样您就不必再经历这些。

此时，api已经过身份验证，您可以开始调用mlkshk服务器。如果您以前经历过这个过程，并且您已经有一个acces代码&secret，那么您可以在实例化它时将它们传递给api。它将类似于：

api = Api(consumer_key='blah',
                  consumer_secret='blahsecretblah',
                  access_token_key='blah',
                  access_token_secret='blahsupersecretblah')

API覆盖率和工作资源：

• GET /api/favorites
• GET /api/favorites/after/(afterkey)
• GET /api/favorites/before/(beforekey)

• GET /api/friends
• GET /api/friends/after/(afterkey)
• GET /api/friends/before/(beforekey)

• GET /api/incoming
• GET /api/incoming/(id)/after/(afterkey)
• GET /api/incoming/(id)/before/(beforekey)

• GET /api/magicfiles
• GET /api/magicfiles/(id)/after/(afterkey)
• GET /api/magicfiles/(id)/before/(beforekey)

• GET /api/shakes
• GET /api/shakes/(id)
• GET /api/shakes/(id)/after/(afterkey)
• GET /api/shakes/(id)/before/(beforekey)

• GET /api/sharedfile/(sharekey)
• POST /api/sharedfile/(sharekey)
• GET /api/sharedfile/(sharekey)/comments
• POST /api/sharedfile/(sharekey)/comments
• POST /api/sharedfile/(sharekey)/like
• POST /api/sharedfile/(sharekey)/save

• GET /api/user
• GET /api/user_id/(user_id)
• GET /api/user_name/(username)

• POST /api/upload

注释

• POST /api/upload返回200个响应，而不是mlkshk文档中所述的201个。
对于不存在的用户X，LI> ^ TT30}$和^ TT31 } $引发500服务器错误，而不是API文档中的404错误。