Configuration Parameters#
These parameters are available to configure the behavior of your application. The parameters in the cli category can be accessed via the command line interface.
Category "app"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| date_format | str | Date format to use | '%Y-%m-%d' | - |
| log_level | str | Logging level for the application | 'INFO' | ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] |
| log_file_max_size | int | Maximum log file size in MB before rotation | 2 | - |
| enable_file_logging | bool | Enable logging to file | True | [True, False] |
| enable_console_logging | bool | Enable logging to console | True | [True, False] |
| theme | str | GUI theme setting supported by ttkbootstrap | 'darkly' | ['cosmo', 'flatly', 'litera', 'minty', 'lumen', 'sandstone', 'yeti', 'pulse', 'united', 'darkly', 'superhero', 'solar', 'cyborg', 'vapor', 'simplex'] |
Category "general"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| photoDirectory | PosixPath | Path to the directory containing photos (absolute, or relative to this config.ini file) | PosixPath('images') | - |
| anniversariesConfig | PosixPath | Path to anniversaries.ini file (absolute, or relative to this config.ini file) | PosixPath('anniversaries.ini') | - |
| locationsConfig | PosixPath | Path to locations.ini file (absolute, or relative to this config.ini file) | PosixPath('locations_en.ini') | - |
| compositionTitle | str | This is the title of the composition on the first page. Leave empty if not required. | 'This is the title of the composition' | - |
Category "calendar"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| useCalendar | bool | True: Calendar elements are generated | True | [True, False] |
| language | str | Language for the calendar (e.g., de_DE, en_US) | 'de_DE' | - |
| holidayCountries | str | Country/state codes for public holidays, e.g., NY,CA | 'SN' | - |
| startDate | datetime | Start date of the calendar | datetime.datetime(2025, 12, 29, 0, 0) | - |
| collagesToGenerate | int | Number of collages to be generated (e.g. number of weeks) | 53 | - |
Category "style"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| backgroundColor | Color | Background color (RGB) | Color(20, 20, 20) | - |
| fontLarge | Font | Font size for large text like the title and the weekday numbers | Font(type='DejaVuSans.ttf', size=9, color=Color(255, 255, 255)) | - |
| fontSmall | Font | Font size for small text like the weekday names | Font(type='DejaVuSans.ttf', size=2.5, color=Color(150, 150, 150)) | - |
| fontDescription | Font | Font for the description texts | Font(type='DejaVuSans.ttf', size=2.5, color=Color(150, 150, 150)) | - |
| fontAnniversaries | Font | Font size for anniversaries: Text with anniversaries and holiday names | Font(type='DejaVuSans.ttf', size=2.0, color=Color(255, 0, 0)) | - |
Category "geo"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| usePhotoLocationMaps | bool | Use GPS data to generate maps | True | [True, False] |
| minimalExtension | int | Minimum range for map display (degrees) | 7 | - |
Category "size"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| width | int | Width of the collage in mm | 216 | - |
| height | int | Height of the collage in mm | 154 | - |
| calendarHeight | int | Height of the calendar area in mm | 18 | - |
| mapWidth | int | Width of the locations map in mm | 20 | - |
| mapHeight | int | Height of the locations map in mm | 20 | - |
| dpi | int | Resolution of the image in dpi | 300 | - |
| jpgQuality | int | JPG compression quality (1-100) | 90 | - |
Category "layout"#
| Name | Type | Description | Default | Choices |
|---|---|---|---|---|
| marginTop | int | Top margin in mm | 6 | - |
| marginBottom | int | Bottom margin in mm | 3 | - |
| marginSides | int | Side margins in mm | 3 | - |
| spacing | int | Spacing between elements in mm | 2 | - |
| useRoundedCorners | bool | Use rounded corners at the edges of the images in the collage | True | [True, False] |
| imageScoreFactor | float | Factor how much the objects (humans, animals, ...) in the image are considered for weighting the image size | 2.0 | - |
| useShortDayNames | bool | Use short weekday names (e.g., Mon, Tue) | False | [True, False] |
| useShortMonthNames | bool | Use short month names (e.g., Jan, Feb) | True | [True, False] |
| usePhotoDescription | bool | Include photo descriptions in the collage | True | [True, False] |
| generatePdf | bool | Combine all generated collages into one pdf | True | [True, False] |
| objectRecognition | bool | Use neuronal network YOLO (You Only Look Once) object detection model to crop images content-aware. | True | [True, False] |