expose.py

A static site generator for photo diaries, inspired by Expose.

Example

📷 Boundary Waters 🌅 2015 Trip ⛺ With Friends 🚣

Click here! I made this photo diary with expose.py.

Why?

I like what Expose does. But encoding photos and videos takes a long time, and Expose doesn't support:

• Caching
• Multiprocessing
• Skipping rendering altogether and generating HTML
• Dry runs

So I rebuilt the parts of Expose I liked and added features I needed.

I probably won't release this as a Python package. Packaging isn't fun, and this is a fun little script, so clone it and have fun with it!

Installation

This script requires Python 3 and the following dependencies:

• pyprind
• docopt
• jinja2

Install them with the following:

pip3 install pyprind docopt jinja2

Then clone or download this repo into a directory of your choice. Either:

• symlink expose.py somewhere into your $PATH, or
• create an alias pointing to expose.py in your .bashrc/.zsrhc

Usage

expose.py
process photos and videos into a static site photojournal
https://github.com/mplewis/expose.py

Usage:
    expose.py [--verbose --dry-run --site-only]
    expose.py [--dry-run] --create-template
    expose.py --help
    expose.py --version
    expose.py --paths

Options:
    -h, --help             Show this screen
    --version              Show version
    --paths                Show script and working directories
    -v, --verbose          Enable verbose log messages
    -d, --dry-run          Log all actions but don't execute them
    -s, --site-only        Skip rendering and just build HTML
    -c, --create-template  Create a blank metadata.yml for source files

Contributions

If you built a theme for expose.py, share it with me and I'll add it to this repository!

Bug reports, fixes, or features? Feel free to open an issue or pull request any time. You can also email me at matt@mplewis.com.

Thanks to

• tlvince: great code cleanup and feature implementations 🌻

License

Copyright (c) 2015 Matthew Lewis. Licensed under the MIT License.

To Do

Code

• Move JS deps into the app instead of running off cdnjs
• Configurable, non-hard-coded config
• Alternate source/output dirs

Docs

• Screenshots
• More in-depth usage
• YAML format docs
• Template
• Styling by slide
• Examples
• Weaknesses
• How it works