diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 22 insertions, 10 deletions
@@ -1,24 +1,36 @@ pyggle – Python Image Gallery for Static Websites --- -**pyggle** generates a static image gallery with javascript lightbox and a bit -of EXIF data for web hosting. It aims to do one thing well and not do anything -else. +**pyggle** generates a static HTML image gallery from filenames passed on the +command line. It aims to do this one thing well and does not support anything +else. Features include: + +* chronological sorting of images via EXIF or filesystem timestamps + (`--sort`, `--reverse`) +* Grouping images by day/month/year + (`--group`, `--group-files`) +* Reverse geocoding to add place names and OpenStreetMap links to image details + (`--with-nominatim`, `--nominatim-zoom`) +* Altering images for publication – note that these edit all files in place + (`--scrub-metadata`, `--resize`, `--exif-copyright`) ## Demo -See [lib.finalrewind.org](https://lib.finalrewind.org/Wildpark%20Bilsteintal%202020/). +See the galleries linked from +[finalrewind.org/pics](https://finalrewind.org/pics/). ## Usage -There's no proper Python package yet. Clone the git repository and run pyggle -from the directory you want to have the gallery in, while passing it some -image files. I.e.: +There is no Python package and thus no installation process. + +Clone the git repository and run pyggle from the directory you want to have the +gallery in, while passing it some image files. I.e.: ``` cd /some/directory -/another/directory/pyggle/bin/pyggle *.jpg +/another/directory/python-image-gallery/bin/pyggle *.jpg ``` -pyggle does not support recursion. All images must be located in the current -working directory. +See `pyggle --help` for a list of options. + +All image files must be located in or below the current working directory. |