mirror of https://github.com/saimn/sigal.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
147 lines
2.7 KiB
147 lines
2.7 KiB
======= |
|
Sigal |
|
======= |
|
|
|
Sigal is yet another simple static gallery generator. It's written in Python |
|
and it allows to build a static gallery of images with the following features: |
|
|
|
* process directories recursively, |
|
* resize images and create thumbnails, |
|
* generate html pages using jinja2 templates, |
|
* relative links for a portable output, |
|
* MIT licensed. |
|
|
|
Links |
|
|
|
* Latest documentation on `readthedocs.org`_ |
|
* Source, issues and pull requests on `Github`_ |
|
* Releases on `PyPI`_ |
|
|
|
.. _readthedocs.org: http://sigal.rtfd.org/ |
|
.. _Github: https://github.com/saimn/sigal/ |
|
.. _PyPI: http://pypi.python.org/pypi/sigal |
|
|
|
Installation |
|
------------ |
|
|
|
Install the extension with one of the following commands:: |
|
|
|
$ easy_install sigal |
|
|
|
or alternatively if you have pip installed:: |
|
|
|
$ pip install sigal |
|
|
|
Dependencies |
|
~~~~~~~~~~~~ |
|
|
|
- Python Imaging Library (PIL / Pillow) |
|
- Jinja2 |
|
- Python Markdown |
|
- pyexiv2 (optionnal, used to copy exif metadatas) |
|
|
|
How to Use |
|
---------- |
|
|
|
:: |
|
|
|
$ 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 |
|
|
|
Configuration |
|
------------- |
|
|
|
The configuration for the gallery must be set in ``<input_dir>/sigal.conf``. |
|
|
|
.. code-block:: ini |
|
|
|
[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 |
|
------- |
|
|
|
* galleria: http://galleria.aino.se/ |
|
* WordPress Photography Theme: http://thethemefoundry.com/photography/ |
|
|
|
Changelog |
|
--------- |
|
|
|
Version 0.1 |
|
~~~~~~~~~~~ |
|
|
|
Released on 2012-05-13. |
|
|
|
First public release.
|
|
|