80 lines
2.1 KiB
Plaintext
80 lines
2.1 KiB
Plaintext
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)
|
|
- Jinja2
|
|
- pyexiv2 (optionnal, used to copy exif metadatas)
|
|
|
|
Usage
|
|
-----
|
|
|
|
$ sigal [-h] [--version] [-c COPYRIGHT] [-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
|
|
-c COPYRIGHT, --copyright COPYRIGHT
|
|
copyright message added to the images
|
|
-f, --force force the reprocessing of existing images and
|
|
thumbnails
|
|
|
|
Settings
|
|
--------
|
|
|
|
Options can be set globally in `~/.config/sigal/sigal.conf` and in the source
|
|
directory `input_dir/sigal.conf`.
|
|
|
|
* theme:
|
|
theme = default
|
|
* size of resized image:
|
|
img_size = 640x480
|
|
* prefix for thumbnails name:
|
|
thumb_prefix = TN-
|
|
* thumbnail size and directory:
|
|
thumb_size = 150x112
|
|
thumb_dir = thumbnail
|
|
* keep big image:
|
|
big_img = 1
|
|
bigimg_dir = original
|
|
* generate squared thumbnails:
|
|
square_thumb = 1
|
|
* jpeg quality:
|
|
jpg_quality = 90
|
|
* keep exif metadatas in output image:
|
|
exif = 1
|
|
* add a copyright text on the image:
|
|
copyright = the copyright msg
|
|
|
|
Album information
|
|
-----------------
|
|
|
|
Information on an album can be given in a file named `album_description` (else
|
|
the directory's name is used) :
|
|
|
|
album_name = "An example gallery"
|
|
album_description = "And a cool description."
|
|
album_representative = "test1.jpg"
|
|
|
|
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/
|