Dev/test ci

.coveragerc

@@ -8,3 +8,4 @@ exclude_lines =
     raise NotImplementedError
     if __name__ == .__main__.:
 ignore_errors = True
+show_missing = True

.github/workflows/devel.yml

@@ -2,12 +2,12 @@ on: [push, pull_request]
 
 jobs:
   tox:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: '3.13'
       - name: Install dependencies
         run: |
           set -xe
@@ -23,12 +23,12 @@ jobs:
           verbose: true
 
   build-example:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: '3.13'
       - name: Install dependencies
         run: |
           set -xe

.github/workflows/release.yml

@@ -23,18 +23,55 @@ jobs:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
 
-  notification:
+  container:
     if: ${{ github.repository == 'recitale/recitale' }}
     needs: pypi-package
     runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Login to GHCR
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and export to Docker
+        uses: docker/build-push-action@v2
+        with:
+          build-args: VERSION=${{ github.ref_name }}
+          context: containers
+          load: true
+          pull: true
+          tags: ${{ github.repository }}:test
+      - name: Minimal test
+        run: |
+          docker run --rm -v $PWD/example:/var/www ${{ github.repository }}:test build
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          build-args: VERSION=${{ github.ref_name }}
+          context: containers
+          pull: true
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:latest
+            ghcr.io/${{ github.repository }}:${{ github.ref_name }}
+
+  notification:
+    if: ${{ github.repository == 'recitale/recitale' }}
+    needs: [pypi-package, container]
+    runs-on: ubuntu-latest
     name: Notifications
     steps:
-      - name: Put release tag into env
-        run: echo "VERSION_TAG=$( echo $GITHUB_REF | grep --only-matching '[^/]*$' )" >> $GITHUB_ENV
       - name: IRC notification
         uses: Gottox/irc-message-action@v2
         with:
           channel: '#recitale'
           nickname: github-bot
           message: |-
-            recitale ${{ env.VERSION_TAG }} was just released. See ${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ env.VERSION_TAG }} for the release notes.
+            recitale ${{ github.ref_name }} was just released. See ${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.ref_name }} for the release notes.

.gitignore

@@ -156,3 +156,6 @@ Sessionx.vim
 tags
 # Persistent undo
 [._]*.un~
+
+# VS Code
+.vscode

MANIFEST.in

@@ -12,3 +12,5 @@ graft recitale/themes
 
 prune example
 exclude example
+prune containers
+exclude containers

README.md

@@ -2,6 +2,8 @@
 <img src="logo.png">
 </p>
 
+PLEP
+
 ![GitHub](https://img.shields.io/github/license/recitale/recitale?color=brightgreen)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/recitale)
 ![PyPI - Status](https://img.shields.io/pypi/status/recitale)
@@ -25,7 +27,7 @@ recitale is sections oriented, make it very flexible, many kinds of section alre
 * Paragraph
 * Iframe (Youtube, Maps, etc..)
 * Quote
-* [And more](http://recitale.readthedocs.io/en/latest/sections.html)
+* [And more](https://recitale.readthedocs.io/en/latest/sections.html)
 
 Important note: This project is considered in alpha state. There may be significant changes in configuration files, API or user interface at any time.
 
@@ -55,10 +57,10 @@ recitale currently supports:
 
 You can find example usages here:
 
-* http://surleschemins.fr
-* http://media.faimaison.net/photos/galerie/
+* https://surleschemins.fr
+* https://media.faimaison.net/photos/galerie/
 * https://www.thebrownianmovement.org/
-* http://outside.browny.pink
+* https://outside.browny.pink
 * http://www.street-art.me
 
  ## Code example
@@ -106,17 +108,23 @@ Options:
   --version     Show version.
 ```
 
-## Docker
+## 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
+```
 
-https://hub.docker.com/r/beudbeud/prosopopee/
+See https://github.com/recitale/recitale/pkgs/container/recitale for fetching instructions and the list of all available images.
 
 ## Licence 
 
 GPL-3.0+
 
 ## Documentation
 
-  http://recitale.readthedocs.org/en/latest/
+  https://recitale.readthedocs.org/en/latest/
 
 ## IRC 
 

containers/Dockerfile

@@ -0,0 +1,13 @@
+from python:slim-bullseye
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y ffmpeg
+
+ARG VERSION
+
+RUN python3 -m pip install -U recitale==$VERSION
+
+RUN mkdir /var/www/
+
+WORKDIR /var/www/
+
+ENTRYPOINT ["recitale"]

docs/build.rst

@@ -16,7 +16,7 @@ You need
 1. Create a folder
 2. Put all pics you want
 3. Create settings.yaml file in the folder
-4. Add title, date and cover key in folder/settings.yaml
+4. Add title key in folder/settings.yaml. Optionally provide a cover and date key, otherwise they are inferred from the oldest file in the gallery.
 5. Use `recitale autogen -d folder`
 
 

docs/changelog.rst

@@ -87,7 +87,7 @@ Thx to all new contributors!
 0.6 (2017-07-14)
 
  * Compatibility python 2 and 3
- * Possibility to add custom css and js http://prosopopee.readthedocs.io/en/latest/theming.html
+ * Possibility to add custom css and js https://prosopopee.readthedocs.io/en/latest/theming.html
  * Add reverse option by titoko https://prosopopee.readthedocs.io/en/latest/configuration.html#reverse
 
 0.5 (2017-06-04)

docs/configuration.rst

@@ -107,7 +107,7 @@ recitale can use ffmpeg or libav and each can be configured if needed::
       video: "libvpx"
       other: "-qmin 10 -qmax 42 -maxrate 500k -bufsize 1500k"
 
-The meaning of the currently supported FFMEG or LIBAV's settings is as follows :
+The meaning of the currently supported FFMPEG or LIBAV's settings is as follows:
 
  * `binary` sets the binary to use to convert the video (ffmpeg or avconv)
  * `loglevel` sets the logging level used by the library
@@ -131,6 +131,36 @@ example for MP4::
       video: "libx264"
       extension: mp4
 
+Audio converter
+~~~~~~~~~~~~~~~
+
+recitale can use ffmpeg to reencode audio and can be configured if needed::
+
+  title: Gallery
+  settings:
+    ffmpeg_audio:
+      binary: "ffmpeg"
+      loglevel: "error"
+      audio: "libvorbis"
+      extension: "mp3"
+
+The meaning of the currently supported FFMPEG settings is as follows:
+
+ * `binary` sets the binary to use to convert the audio (ffmpeg by default)
+ * `loglevel` sets the logging level used by the library
+ * `audio` sets the audio codec
+ * `extension` sets the extension of output file
+
+example for MP3::
+
+  title: Gallery
+  settings:
+    ffmpeg_audio:
+      binary: "ffmpeg"
+      loglevel: "error"
+      audio: "libmp3lame"
+      extension: "mp3"
+
 Light Mode
 ~~~~~~~~~~
 
@@ -256,6 +286,8 @@ If you want to protect all the website by password::
   title: Gallery
   password: my_super_password
 
+Please note that only the HTML page will be password-protected. Media content such as images, videos and audio files can still be accessed without password if someone knows or guesses their URL inside a password-protected gallery.
+
 Date locale
 ~~~~~~~~~~~
 
@@ -268,6 +300,15 @@ If you want to use non-based on LC_TIME locale for human-readable dates on galle
   settings:
     date_locale: ru_RU
 
+Hide gallery date
+~~~~~~~~~~~~~~~~~
+
+By default, recitale shows dates for all galleries in the landing page, just below each gallery title. However, you can hide it by setting the "show_date" setting to "False" in **root** settings.yaml::
+
+  title: My exploration of the outside world
+  sub_title: it's a scary place, don't go there
+  show_date: False
+
 Gallery settings.yaml
 ---------------------
 

docs/index.rst

@@ -6,11 +6,10 @@ For those of you who don't know what exposure.co is, it allows you to tell a sto
 
 You can find example usages here:
 
- * http://surleschemins.fr
- * http://media.faimaison.net/photos/galerie/
+ * https://surleschemins.fr
+ * https://media.faimaison.net/photos/galerie/
  * https://www.thebrownianmovement.org/
- * http://outside.browny.pink
- * http://such.life
+ * https://outside.browny.pink
  * http://www.street-art.me
 
 Why

docs/install.rst

@@ -50,15 +50,11 @@ Installation in virtualenv
 
     pip3 install recitale
 
-Docker
-------
+Container
+---------
 
-Get the Docker image::
+A container image is available at ghcr.io/recitale/recitale. One can build their website by running the following command::
 
-    docker pull beudbeud/prosopopee
-
-Run::
+   docker run --rm -v <PATH_TO_GALLERY_SOURCE>:/var/www ghcr.io/recitale/recitale build
 
-    docker run --rm -v $(pwd):/site beudbeud/prosopopee
-
-More informations https://hub.docker.com/r/beudbeud/prosopopee/
+See https://github.com/recitale/recitale/pkgs/container/recitale for fetching instructions and the list of all available images.

example/settings-menu.yaml

@@ -2,4 +2,4 @@ title: "Example gallery"
 menu:
   - about: "About"
   - first_gallery: "My first gallery"
-  - http://twitter.com: "Twitter"
+  - https://twitter.com: "Twitter"

recitale/__init__.py

@@ -1 +1 @@
-__version__ = "2.0.0a1"
+__version__ = "2.0.0a6"

recitale/audio.py

@@ -1,6 +1,10 @@
 import logging
+import shlex
+import subprocess
+import urllib.parse
 
 from json import dumps as json_dumps
+from json import loads as json_loads
 from pathlib import Path
 from zlib import crc32
 
@@ -10,7 +14,31 @@
 logger = logging.getLogger("recitale." + __name__)
 
 
-class Reencode:
+class AudioCommon:
+    def __get_infos(self):
+        if AudioFactory.global_options["binary"] == "ffmpeg":
+            binary = "ffprobe"
+        else:
+            binary = "avprobe"
+        command = (
+            binary
+            + " -v error -show_entries format=duration "
+            + " -print_format json=compact=1 "
+            + shlex.quote(str(self.filepath))
+        )
+        out = subprocess.check_output(shlex.split(command))
+        infos = json_loads(out)
+        self.dur = float(infos["format"]["duration"])
+
+    @property
+    def duration(self):
+        if not hasattr(self, "dur"):
+            self.__get_infos()
+
+        return self.dur
+
+
+class Reencode(AudioCommon):
     def __init__(self, base_filepath, base_id, extension):
         self.filepath = self.__filepath(base_filepath, base_id, "." + extension)
 
@@ -24,7 +52,7 @@ def __filepath(self, base_filepath, base_id, extension):
         return p.parent / (p.stem + suffix)
 
 
-class BaseAudio:
+class BaseAudio(AudioCommon):
     def __init__(self, filepath, global_options):
         self.reencodes = dict()
         self.options = global_options.copy()
@@ -34,9 +62,12 @@ def __init__(self, filepath, global_options):
             bytes(json_dumps(self.options, sort_keys=True), "utf-8")
         )
 
+    def _add_reencode(self, reencode):
+        return self.reencodes.setdefault(reencode.filepath, reencode)
+
     def reencode(self):
         reencode = Reencode(self.filepath, self.chksum_opt, self.options["extension"])
-        return self.reencodes.setdefault(reencode.filepath, reencode).filepath.name
+        return urllib.parse.quote(self._add_reencode(reencode).filepath.name)
 
 
 # TODO: add support for looking into parent directories (name: ../other_gallery/pic.jpg)