README.md

PyFlickr - An Unofficial Flickr API

PyFlickr provides python-developers to access to user, albums, photos and other public information from Flickr website in read-only mode. This API also provides some easy ways to download public photos and albums. You can customize these to fit your requirements.

📕 Setup

To install PyFlickr, simply use pip:

$ pip install PyFlickr

Then, before using, you have to download Chromedriver to driver folder and unzip it.

$ mkdir driver
$ cd driver
$ curl -O https://chromedriver.storage.googleapis.com/{VERSION}/chromedriver_{OS}.zip
$ unzip chromedriver_{OS}.zip

Remember to update{VERSION}with the latest version and{OS}with your computer OS.

For example:

# version 2.41 on Mac
$ curl -O https://chromedriver.storage.googleapis.com/2.41/chromedriver_mac64.zip

# version 2.41 on Windows
$ curl -O https://chromedriver.storage.googleapis.com/2.41/chromedriver_win32.zip

📗 Getting Start

Start by importing module - PyFlickr:

from pyflickr import PyFlickr

📘 Documentation

PyFlickr provides 5 features : User Information, Photo Size Information, Photo Direct Url, Download Single Photo, Download Single Album.

❗️ For more details, please see PyFlickr Guide .

Example :

# This example shows : Download all of albums of one user in a new folder named "ResultFolder"
# '139958401@N06' is user's id, please see PyFlickr feature - "User Information" to get it.

from pyflickr import PyFlickr

user = PyFlickr.getUser('139958401@N06')
result = user.getAlbums(limit_trigger = False)
albums = result['Albums_Result']
for album_data in albums:
	album_url = album_data['url']
	PyFlickr.singleAlbum_DL(album_url = album_url, folder_path='ResultFolder')

📙 Development

It's simple to run PyFlickr on your computer. Follow instruction below step-by-step:

$ git clone https://github.com/rf777rf777/PyFlickr.git
$ cd PyFlickr
$ pip install -r requirements.txt

Then, as mentioned previously, please setup your Chromedriver (see Setup).

📝 License

Licensed under MIT license.