Package: pelican-flickr
Flickr in your Pelican website==============================This `Pelican <http://getpelican.com>`_ plugin brings your Flickr photos& sets into your static website.Install-------Install this plugin and its dependencies with ``pip install pelican-flickr``Add the plugin path to your **PLUGINS** setting in the pelicanconf.pyfile. ``PLUGINS = ['pelican-flickr', ]``You must setup at least twosettings for this plugin to work (see Settings section for moredetails): \* FLICKR\_API\_KEY \* FLICKR\_USERFinally, you can run ``pelican`` to render your website.For the first run, as the cache is empty and can be quite long topopulate i recommend using ``pelican --debug`` to see what ishappening...You can view a demo on my `Personal Website` <http://bastien.abadie.me>Settings--------The following settings should be specified in your pelican configurationfile, usually ``pelicanconf.py``FLICKR\_API\_KEY~~~~~~~~~~~~~~~~This setting is **mandatory**.If you don't already have one, you must ask for a Flickr `Apikey <https://www.flickr.com/services/apps/create/apply>`_ (it's free).Here we only need the key, not the secret part used only forauthentified actions.FLICKR\_USER~~~~~~~~~~~~This setting is **mandatory**.Use `idGettr <http://idgettr.com/(env)>`_ to find your Flickr id, itshould look like ``XXXXXXXX@YYY``FLICKR\_OUTPUT\_DIRNAME~~~~~~~~~~~~~~~~~~~~~~~This setting is optional, its default value is ``flickr``.This setting sets the name of the output directory for all the filesgenerated by this plugin (sets & photos). It will be a part of the urlson your website.FLICKR\_UPDATE~~~~~~~~~~~~~~This setting is optional, its default value is ``True``.To speed up cache usage & overall rendering we can forbid the usage ofthe Flickr API once the cache has been built, by setting it to``False``.FLICKR\_CACHE~~~~~~~~~~~~~This setting is optional, its default value is ``True``.This is a bit the opposite effect of FLICKR\_UPDATE, as it forbids theusage of the cache when sets to ``False``.Essentially for development & testing purposes.FLICKR\_SETS\_EXCLUDE~~~~~~~~~~~~~~~~~~~~~This setting is optional, its default value is ``None``.You can specify a list of Flickr sets id or name, to exclude them onyour website.Example~~~~~~~My config looks like this: ::FLICKR_API_KEY = 'xxxXXXxC0FFEE'FLICKR_USER = '123456789@YYY'FLICKR_SETS_EXCLUDE = ['Compromising pictures', ]FLICKR_OUTPUT_DIRNAME = 'photos'FLICKR_UPDATE = FalseTemplates---------General context (any page)~~~~~~~~~~~~~~~~~~~~~~~~~~You can access all your Flickr photosets from any generated page usingthe ``flickr_sets`` variable as in the example below. ::{% for set in flickr_sets %}<div class="set"><a class="primary" href="{{ set.url }}"><img class="light" src="{{ set.primary.sizes.medium.source }}" />{{ set.title }}</a></div>{% endfor %}Photosets~~~~~~~~~Every photoset available will have a file generated in the``FLICKR_OUTPUT_DIRNAME``A variable named **photoset** is added to this page's context. Thisplugin embeds a default template ``flickr_set.html`` that you canoverride by creating a file in your template dir with the same name.Here is basically the content of the default file: ::<h1>{{ photoset.title }}</h1>{% for photo in photoset.photos %}<a href="{{photo.url}}"><img src="{{photo.sizes.largesquare.source}}" title="{{photo.title}}" /></a>{% endfor %}A photoset has an instance of a photo named primary which is the cover pPhotos~~~~~~As for the photo sets, each available photo generates a page, in asubfolder per photoset of ``FLICKR_OUTPUT_DIRNAME`` (ie.output/flickr/my-set/425169.html for the photo with id 425169).Several variables are added to the page context:-  ``photoset`` is the parent photo set object-  ``photo`` is the current photo object-  ``photo_previous`` is the possible previous photo object in theparent set (may be null)-  ``photo_next`` is the possible next photo object in the parent set(may be null)Each photo has several attributes:-  sizes is a dictionary of available image size with their direct urls-  tags is a list of Flickr tag (not yet asociated with Pelican tags)-  urls is a dictionary of Flickr urls about this photoYou can override the default ``flickr_photo.html`` by adding a file withthe same name in your template dir.