Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 (default, material, 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/orgs/recitale/packages/container/package/recitale%2Frecitale for fetching instructions and the list of all available images.

Licence

GPL-3.0+

Documentation

http://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.

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.0a2.tar.gz (18.2 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.0a2-py3-none-any.whl (9.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: recitale-2.0.0a2.tar.gz
  • Upload date:
  • Size: 18.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for recitale-2.0.0a2.tar.gz
Algorithm Hash digest
SHA256 adf02fe9046d2b5e39f9c562cd6af05b6983eb54dbb87341ce23012d1772a54e
MD5 fb492d0fd93c62cf1ccdd29280964bfb
BLAKE2b-256 bff3ffb47eb789f451d0e49a14d1a916ce900ad208f150bec5025b6a9ab2c2b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recitale-2.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 9.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for recitale-2.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 85c1c4d86f61ce79ae621cfd041357f6ef558444aab64bc073649b50c0e2a696
MD5 05008ed536bf44420af434986a96dd02
BLAKE2b-256 99c0112e84132059f7f07143780cd5d179d4a77bf81cec940d18d64908b9d657

See more details on using hashes here.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page