Skip to content

rtts/photog

main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

Photog!

Photog! turns a directory tree of source images into a beautiful photography website that maximizes the ease of both viewing and downloading the pictures.

Photog! was created by Return to the Source for Super Formosa Photography and provided here for everyone to use under the terms of the AGPL license as part of our free and open source philosophy.

Screenshot of Super Formosa Photography

Features

Photog! stands on the shoulders of giants.

  • The thumbnails are displayed in a responsive gallery that recalculates the correct image dimensions in an aesthetically pleasing way, thanks to the algorithm from https://github.com/ptgamr/google-image-layout.

  • Clicking a thumbnail opens the PhotoSwipe gallery by @dimsemenov, with the following features of its own:

    • Touch gestures
    • Browser History API
    • Progressive loading
    • Fullscreen support
    • Share button
  • Adding /all.zip to the end of the URL will download a ZIP file containing all the images in two different resolutions:

    1. The original images, unmodified, in the subfolder "print"
    2. Images scaled to a width of 2000 pixels, in the subfolder "web"
  • The default template shows the logo Super Formosa Photography at the top and license terms at the bottom. To override this, see the section "Customization" below.

Installation

Photog! requires Python 3.8 or higher. You can check if this is available on your system by running the following command:

$ python3 --version

Now you can install Photog! with pip:

$ python3 -m pip install photog

Usage

First, navigate to your Pictures directory:

$ cd ~/Pictures

Now, run the photog command, specifying the current directory (.) as its argument:

$ photog .

Photog! will now traverse your pictures folder and generate HTML files , image thumbnails, and zipfiles. If you want to only update a specific subdirectory and not regenerate the entire website, run photog without arguments inside that directory:

$ cd ~/Pictures/wedding
$ photog

The difference is that without arguments, Photog! will not create a static directory to hold the static files. Otherwise the two previous commands are identical.

After Photog! has completed its run, you can use Python's built-in webserver to view your website:

$ python3 -m http.server

Your website will now be available at the following URL: http://localhost:8000/

Configuration

You can configure the behavior of Photog! in a file called photog.ini. This file holds the configuration variables per directory. The configuration variables are:

Sorting

  • sort = ascending to sort photos ascending according to EXIF date
  • sort = descending to sort photos descending according to EXIF date
  • sort = random to randomize the order of photos

Zipping

  • zip = true creates a zipfile called all.zip
  • zip = false disables the creation of zipfiles

Customization

It is expected that you customize the default template. Save this file as template.html in the root of your Pictures folder and edit as needed. Then, run photog to use your customized template instead of the default one.

About

The static photography website generator used by Super Formosa Photography

Topics

Resources

License

Stars

Watchers

Forks