Welcome to Hummingbird API Wrapper’s documentation!

'Stories in Ready'

Hummingbird is a wrapper that aims to create a simple interface to hummingbird.me’s API.

Here’s a example, getting the information about “Neon Genesis Evangelion”

>>> import hummingbird
>>> bird = hummingbird.Hummingbird('username', 'password')
>>> results = bird.search_anime('Evangelion')
>>> for result in results:
...     print(result.title)
Petit Eva: Evangelion@School
Neon Genesis Evangelion
Evangelion: 4.0
Evangelion: 1.0 You Are (Not) Alone
Evangelion: 2.0 You Can (Not) Advance
>>> results[1].status
'Finished Airing'

Contents

References and Other Relevant Things

Installation

Hummingbird is supported by anything above python 3.0. The recommended way to install is via pip

$ pip install hummingbird

If you don’t have pip installed, then the Hitchhiker’s Guide to Python has a section for setting it up on Windows, Mac and Linux. There is also a Stack overflow question on installing pip on Windows that might prove helpful.

Alternatively you can do it via easy_install

$ easy_install hummingbird

Support

Contact KnightHawk3 on Hummingbird or email me at Melody@Melody.Blue. Eventually there will be a subreddit or wiki for support.

If you’ve uncovered a bug or have a feature request, then make an issue on the project page at github.

Indices and tables