Python-Instagram 项目技术文档

1. 安装指南

安装步骤

1. 使用 pip 安装 python-instagram：

   pip install python-instagram
   

2. 确保安装了以下依赖库：

   • httplib2
   • simplejson
   • six

注意事项

• 该项目目前不再积极维护，使用时需自行承担风险。

2. 项目的使用说明

项目简介

python-instagram 是一个用于访问 Instagram REST 和 Search API 的 Python 客户端库，支持 Python 2 和 Python 3。

主要功能

• 访问 Instagram 的 REST 和 Search API。
• 支持 OAuth2 认证。
• 提供实时订阅功能。
• 支持多种 API 端点，如用户、媒体、评论、标签等。

3. 项目 API 使用文档

认证

Instagram API 使用 OAuth2 协议进行认证。部分功能不需要认证。

获取访问令牌

1. 使用提供的 get_access_token.py 脚本获取访问令牌。
2. 脚本会提示输入应用的 Client ID、Client Secret 和 Redirect URI，并指导你获取访问令牌。

用户认证

示例应用展示了简单的 OAuth 流程，用于用户认证并获取访问令牌。

使用访问令牌

获取访问令牌后，可以将其传递给 InstagramAPI 构造函数：

from instagram.client import InstagramAPI

access_token = "YOUR_ACCESS_TOKEN"
client_secret = "YOUR_CLIENT_SECRET"
api = InstagramAPI(access_token=access_token, client_secret=client_secret)
recent_media, next_ = api.user_recent_media(user_id="userid", count=10)
for media in recent_media:
   print media.caption.text

未认证请求

对于不需要认证的方法，只需传递 Client ID 和 Client Secret：

api = InstagramAPI(client_id='YOUR_CLIENT_ID', client_secret='YOUR_CLIENT_SECRET')
popular_media = api.media_popular(count=20)
for media in popular_media:
    print media.images['standard_resolution'].url

实时订阅

可以使用 API 订阅用户、标签、位置或地理区域：

api.create_subscription(object='user', aspect='media', callback_url='http://mydomain.com/hook/instagram')

数据检索

API 提供了多种方法来检索用户、媒体、评论、标签等数据。例如：

recent_media, next_ = api.user_recent_media()
photos = []
for media in recent_media:
    photos.append('<img src="%s"/>' % media.images['thumbnail'].url)

4. 项目安装方式

通过 pip 安装

pip install python-instagram

依赖库

• httplib2
• simplejson
• six

示例应用

项目包含一个示例应用，展示了如何进行用户认证、订阅和更新处理。运行示例应用的步骤如下：

1. 安装 bottle 和 bottle-session：

   pip install bottle
   pip install bottle-session
   

2. 运行 Redis 实例。
3. 在开发者配置文件中设置重定向 URI 为 http://localhost:8515/oauth_callback。
4. 更新 sample_app.py 中的 client_id 和 client_secret，并设置重定向 URI。
5. 运行 sample_app.py，访问 http://localhost:8515 进行测试。

5. 错误处理

导入 bind 模块可以处理特定的错误状态码。例如：

from instagram.bind import InstagramAPIError

try:
   # your code goes here
except InstagramAPIError as e:
   if (e.status_code == 400):
      print "\nUser is set to private."

6. 贡献指南

欢迎为项目贡献代码，具体步骤如下：

1. 创建一个分支。
2. 实现功能或修复 bug。
3. 运行测试。
4. 提交拉取请求。

7. 常见问题

如果导入 Instagram 时出现模块未定义的错误，可能需要升级 six 包：

sudo pip install --upgrade six

通过以上文档，您可以详细了解如何安装、使用和贡献 python-instagram 项目。