Skip to main content

A static website generator that allows you to tell a story with your pictures

Project description

GitHub PyPI - Python Version PyPI - Status GitHub release (latest SemVer) PyPI Read the Docs GitHub Build GitHub Release Codecov devel

recitale

recitale. Static site generator for your story.

Make beautiful customizable pictures galleries that tell a story using a static website generator written in Python. You don't need to care about css, code and presentation, manage your contents in YAML file and recitale will take care about the rest.

recitale is sections oriented, make it very flexible, many kinds of section already available:

  • Parallax
  • Group of pics (gallery)
  • Paragraph
  • Iframe (Youtube, Maps, etc..)
  • Quote
  • And more

Important note: This project is considered in alpha state. There may be significant changes in configuration files, API or user interface at any time.

Screenshots

Features

recitale currently supports:

  • Automatic generation
  • Lightweight
  • Thumbnails & multiple resolutions for fast previews (JPEG progressive)
  • Videos support
  • Mobile friendly
  • Caching for fast rendering
  • Multi level gallery
  • Support themes (exposure (default), light)
  • Password access (encrypt page)
  • Image lazy loading
  • Night Mode
  • Completely static output is easy to host anywhere
  • Hackable

Examples

You can find example usages here:

Code example

title: Title
date: 2015-12-18
cover: P1070043-01-01.jpeg
sections:
  - type: full-picture
    image: P1060979-01-01.jpeg
    fixed: true
    text:
      title: My Story
      sub_title: some subtitle
      date: 2015-12-18
  - type: paragraph
    title: Beautiful Title
    text: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor
  - type: pictures-group
    images:
      -
        - P1060938-01-01.jpeg
        - P1060946-01-01.jpeg
        - P1060947-01-01.jpeg
        - P1060948-01-01.jpeg

Usage

  recitale
  recitale test
  recitale preview
  recitale deploy
  recitale autogen (-d <folder> | --all ) [--force]
  recitale (-h | --help)
  recitale --version
                                                                                
Options:                                                                        
  test          Verify all your yaml data                                       
  preview       Start preview webserver on port 8000                            
  deploy        Deploy your website                                             
  autogen       Generate gallery automaticaly                                   
  -h, --help    Show this screen.                                               
  --version     Show version.

Container

A container image is available at ghcr.io/recitale/recitale. One can build their website by running the following command:

docker run --rm -v <PATH_TO_GALLERY_SOURCE>:/var/www ghcr.io/recitale/recitale build

See https://github.com/recitale/recitale/pkgs/container/recitale for fetching instructions and the list of all available images.

Licence

GPL-3.0+

Documentation

https://recitale.readthedocs.org/en/latest/

IRC

channel : irc.libera.chat#recitale

Origin

recitale started as a fork of prosopopee.

recitale is a contraction of tale and the French word récit which are both depicting the same thing: a story.

It is also a play on recital which is related to poetry reading.

recitale should be pronounced /ʁe.siˈteɪl/ that is, the French pronounciation for récit followed by the English pronounciation of tale.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

recitale-2.0.0b2.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

recitale-2.0.0b2-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file recitale-2.0.0b2.tar.gz.

File metadata

  • Download URL: recitale-2.0.0b2.tar.gz
  • Upload date:
  • Size: 10.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for recitale-2.0.0b2.tar.gz
Algorithm Hash digest
SHA256 8e5465e9957e0ff66a287d4d420659ae8b3c266fb6a01268424fa1fb4b51f5d7
MD5 09e1736d915385591e9d860624313735
BLAKE2b-256 0a820ea8c8185ea5008404cb826d6acd0f442ec74188a1d203c2d5a4a67e4066

See more details on using hashes here.

Provenance

The following attestation bundles were made for recitale-2.0.0b2.tar.gz:

Publisher: release.yml on recitale/recitale

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file recitale-2.0.0b2-py3-none-any.whl.

File metadata

  • Download URL: recitale-2.0.0b2-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for recitale-2.0.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 ca2d6a7b67f975a909970f13ff2ac89f335ea3c08e216557b41d434efda4883c
MD5 0fad93b2d1d48bc3ca2dfb642d4d9e3a
BLAKE2b-256 901dbf8e50040fe49465a584d1d5077e3f07877af4ba1137465a1f918ac3e8e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for recitale-2.0.0b2-py3-none-any.whl:

Publisher: release.yml on recitale/recitale

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page