Metadata-Version: 2.1
Name: galgen
Version: 0.2.0
Summary: Simple gallery generator.
License: MIT
Author: Grzegorz  Krason
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: coloredlogs (>=15.0.1,<16.0.0)
Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Description-Content-Type: text/markdown

# GalGen

Simple gallery generator.

## Features

- Simple
- Reliable
- Customizable

## Demo

Sample gallery can be found [here](https://filedn.com/ls8U70bX0lASS65WlPE8h3j).

## Installing

```sh
pip install galgen
```

## Getting Started

Let's say we have the following file structure:

```
holidays/
  day1/
    pic1.jpg
    pic2.jpg
    pic3.jpg
    thumnails/
      pic1.jpg
      pic2.jpg
      pic3.jpg
  day2/
    pic1.jpg
    pic2.jpg
    pic3.jpg
    thumnails/
      pic1.jpg
      pic2.jpg
      pic3.jpg

```

To generate and open your gallery invoke the following:
```sh
$ galgen init path/to/holidays
$ galgen build --open path/to/holidays
```

- One or more directories with the pictures are required.
- Define content of your gallery in `gengal-config.yml`
- Customize layout in `index.html.j2`

Rebuild your gallery whenever pictures are added/removed or other changes applied.
```sh
$ galgen build --force path/to/holidays
```

# Thumnails

- Thumnails are optional. Skip them (for simplicity) or generate manually (for performance).
- Size of the thumnails is of your choice.
- Filenames of the thumnails must correspond to the filenames of the full-scale pictures.

