flickr-photos-api 1.5.6

Look up information about photos and collections of photos from Flickr

flickr-photos-api

This is a library for getting information about photos from the Flickr API.

It's not a general-purpose Flickr API library. Instead, it focuses on providing information about photos and photo collections. It tries to abstract away some of the details of the Flickr API -- for example, licenses are returned as complete dictionaries, rather than as the numeric license IDs returned by Flickr API methods.

Examples:

>>> from flickr_photos_api import FlickrPhotosApi
>>> api = FlickrPhotosApi(api_key="…", user_agent="…")

>>> photo = api.get_single_photo(photo_id="14898030836")

>>> photo
{'id': '14898030836', 'title': 'NASA Scientists Says', …}

>>> photo["license"]
{'id': 'cc-by-2.0', 'label': 'CC BY 2.0', 'url': 'https://creativecommons.org/licenses/by/2.0/'}

>>> photo["url"]
'https://www.flickr.com/photos/lassennps/14898030836/'

This library was created for use in Flinumeratr, Flickypedia, and other Flickr Foundation projects.

Usage

1. Install flickr-photos-api from PyPI:

   $ pip install flickr-photos-api
   

2. Construct an instance of FlickrPhotosApi. You need to pass a user-agent that identifies you, and a Flickr API key.

   from flickr_photos_api import FlickrPhotosApi
   
   api = FlickrPhotosApi(api_key="…", user_agent="…")
   

3. Call methods on FlickrPhotosApi. The methods meant for public use are:

   def get_single_photo(photo_id: str) -> SinglePhoto: ...
   
   def get_photos_in_album(user_url: str, album_id: str) -> PhotosInAlbum: ...
   
   def get_photos_in_gallery(gallery_id: str) -> PhotosInGallery: ...
   
   def get_public_photos_by_user(user_url: str) -> CollectionOfPhotos: ...
   
   def get_photos_in_group_pool(group_url: str) -> PhotosInGroup: ...
   
   def get_photos_with_tag(tag: str) -> CollectionOfPhotos: ...
   

   Methods that return collections of photos also support page and per_page parameters to control pagination.

Development

If you want to make changes to the library, there are instructions in CONTRIBUTING.md.

License

This project is dual-licensed as Apache-2.0 and MIT.