giphypop 0.3

要求、安装和兼容性

唯一的依赖项包含在 requirements.txt 中，是 requests。如果您正在使用pip，可以安装 giphypop

$ pip install requests giphypop

或者

$ pip install requests
$ pip install -e git+https://github.com/shaunduncan/giphypop.git#egg=giphypop

然后您就可以开始使用。 giphypop 已经在python版本 2.6, 2.7, 3.2 和 3.3 上进行了测试。

入门

使用 giphypop 简单直接，旨在提供与api的交互，而不需要关注大量JSON数据。要开始，您可以使用包含API密钥测试各种功能。但是，请注意，虽然 Giphy 一直很慷慨地提供公开的“测试”密钥，但将来可能会关闭。有关更多信息，请参阅api文档。

与Giphy API交互的入口是giphypop.Giphy类。该类可选接受两个参数：api_key和strict。当未设置时，api_key参数默认为公开密钥（见上文）。strict参数控制当没有返回结果时API如何响应。如果启用，将引发异常，否则返回None。

>>> import giphypop
>>> g = giphypop.Giphy()

现在你可以开始操作了。有几个关键的giphypop.Giphy对象的方法是你需要知道的

>>> g = giphypop.Giphy()
>>> results = [x for x in g.search('foo')]

处理结果

所有代表单个图像的结果都被包裹在giphypop.GiphyImage对象中。此对象的行为像字典，但也公开了作为属性的键。请注意，这些不是API响应对象的直接镜像；它们的目的是更简单。结构遵循以下布局

<Result Object>
    - id
    - type: image type (i.e. gif)
    - url: URL to giphy page
    - raw_data: copy of original data response from giphy (JSON)
    - fullscreen: bit.ly link to giphy fullscreen gif
    - tiled: bit.ly link to giphy tiled gif
    - bitly: bit.ly version of `url`
    - media_url: URL directly to image (original size)
    - frames: number of frames
    - height: image height (original image)
    - width: image width (original image)
    - size: filesize (in bytes, original image)
    - fixed_height: (variable width @ 200px height)
        - url: URL directly to image
        - width: image width
        - height: image height
        - downsampled:
            - url: URL directly to image
            - width: image width
            - height: image height
        - still: (a still image of gif)
            - url: URL directly to image
            - width: image width
            - height: image height
    - fixed_width: (variable height @ 200px width)
        - url: URL directly to image
        - width: image width
        - height: image height
        - downsampled:
            - url: URL directly to image
            - width: image width
            - height: image height
        - still: (a still image of gif)
            - url: URL directly to image
            - width: image width
            - height: image height

例如

>>> from giphypop import translate
>>> img = translate('foo')
>>> img.url
'http://giphy.com/foo/bar/baz'
>>> img.width
200
>>> img.fixed_height.downsampled.url
'http://giphy.com/foo/bar/downsampled'

上传

Giphy API 接受上传 GIF 或视频。您可以使用公开 API 密钥进行上传，但无法将它们分配给您的用户名或删除它们。为了上传到您的账户，在上传时设置 用户名 和 API 密钥。

例如

>>> from giphypop import upload
>>> gif = upload(["foo", "bar"], "mycat.gif")
>>> gif
GiphyImage<26BRvG76mOYcvRxss> at http://giphy.com/gifs/bar-foo-26BRvG76mOYcvRxss

或者使用您自己的 API 密钥上传到您的账户

>>> from giphypop import upload
>>> gif = upload(["foo", "bar"], "mycat.gif", username="gifsarefun", api_key="abcdef12345678")
>>> gif
GiphyImage<26BRvG76mOYcvRxss> at http://giphy.com/gifs/bar-foo-26BRvG76mOYcvRxss

变更日志

0.1

• 初始版本

贡献和许可

由 Shaun Duncan 开发，并遵循 MIT 许可协议。欢迎并感谢贡献！