=====================================================
 sigal - yet another simple static gallery generator
=====================================================

sigal is yet another python script to build a static gallery of images:

* process directories recursively,
* resize images and create thumbnails,
* generate html pages using jinja2 templates and with relative links for a
  portable output.

Dependencies
------------

- Python Imaging Library (PIL / Pillow)
- Jinja2
- Python Markdown
- pyexiv2 (optionnal, used to copy exif metadatas)

Usage
-----

::

    $ sigal [-h] [--version] [-f] input_dir output_dir

Required arguments:

================ =====================
 ``input_dir``	  input directory
 ``output_dir``   output directory
================ =====================

Optional arguments:

=================== ==============================================
 ``-h|--help``	     Show this help message and exit
 ``--version``	     Show program's version number and exit
 ``-f|--force``	     Force the reprocessing of existing images and thumbnails
 ``-v, --verbose``   Show all messages.
 ``-d, --debug``     Show all message, including debug messages.
=================== ==============================================

Settings
--------

The configuration for the gallery must be set in ``<input_dir>/sigal.conf``.

::

    [sigal]

    # theme
    theme = default

    # size of resized image
    img_size = 640x480

    # generate thumbnails
    make_thumbs = 1

    # directory of the thumbnails
    thumb_dir = thumbnail

    # prefix for thumbnails name
    thumb_prefix = tn-

    # thumbnail size
    thumb_size = 200x150

    # crop the image to fill the box
    thumb_fit = 1

    # keep big image
    big_img = 1
    bigimg_dir = original

    # jpeg quality
    jpg_quality = 90

    # keep exif metadatas in output image
    exif = 1

    # add a copyright text on the image
    copyright = An example copyright message


Album information
-----------------

Information on an album can be given in a file using the markdown syntax,
named `index.mkd` ::

    Title: Another example gallery
    Representative: test2.jpg

    And a *cool* description.

If this file does not exist the directory's name is used for the title, and
the first image of the directory is used as representative.

Credits
-------

sigal use or is inspired from some code from other projects:

* galleria: http://galleria.aino.se/
* WordPress Photography Theme: http://thethemefoundry.com/photography/
* lazygal: http://sousmonlit.dyndns.org/~niol/playa/oss/projects/lazygal/