Metadata-Version: 2.4
Name: photoweb
Version: 0.5.5
Summary: Templated HTML galleries based on in-photo metadata
Author-email: Mark Nottingham <mnot@mnot.net>
License: Copyright (c) Mark Nottingham
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: homepage, https://github.com/mnot/photoweb
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pillow
Requires-Dist: jinja2
Requires-Dist: defusedxml
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-md; extra == "dev"
Requires-Dist: validate-pyproject; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# Photoweb

Photoweb creates HTML galleries based on in-photo metadata, using flexible
templates. What's different about it?

* It's easy to add new photos; just drop them in the folder and re-run.
* You don't have to track metadata; it comes from the photos themselves, using
  standard embedded metadata (EXIF, IPTC, XMP).
* It includes specialized support for titles and descriptions from Apple Photos.
* It's easy to modify the templates to make your photos look great.
* It supports modern web features like dark mode, keyboard navigation, and 
  responsive side-by-side layouts out of the box.


## Installation

Photoweb needs [Python](https://www.python.org/).

It's easiest with [pipx](https://pipx.pypa.io/stable/):

> pipx install photoweb


## Usage

To generate the HTML for a gallery, call it from the command line:

> photoweb . 

You can generate multiple galleries at once:

> photoweb beach hawaii snow

When you first generate a gallery, you can specify the page title and
description, which will be used in the template:

> photoweb -p "At the Beach" -d "We went to the beach for a weekend. Fun!" . 

The page metadata will be saved in a file (md.json) for use next time you
run photoweb. 


## Creating and Using Templates

By default, the bundled default template will be used. You can edit this, or
create new templates, using them with the -t option:

> photoweb -t "my template" .

To bootstrap your own template, you can copy the default one:

> photoweb --copy-templates ./my-custom-design

Templates are directories with the following files in them:

* md.json - a configuration file
* gallery.html - the overview page
* detail.html - a single photo page
* style.css - visual styling
* photoweb.js - interactive logic (for keyboard navigation and zoom)

Take a look at the default template to get an idea of how to create your own.


## Navigation and Shortcuts

When viewing a photo in the generated gallery:
* **Left/Right Arrow keys**: Previous/Next photo.
* **Escape**: Return to the gallery index.
* **Click/Tap**: Toggle between fit-to-screen and full-size view.
