Merge 'develop' into master (#207)

Getting ready for version 0.6 🚀

.circleci/config.yml

@@ -0,0 +1,114 @@
+version: 2.1
+jobs:
+  build-flatpak:
+    machine:
+      image: ubuntu-2204:2023.07.2
+
+    working_directory: ~/repo
+
+    environment:
+      BUILD_BRANCH: $CIRCLE_BRANCH
+      BUILD_COMMIT: $CIRCLE_SHA1
+
+    steps:
+      - checkout
+
+      - run:
+          name: SYSTEM ⟹ Install required packages
+          command: |
+            sudo apt-get -qq update
+            sudo apt-get install -y software-properties-common python3-software-properties
+            sudo add-apt-repository -y ppa:flatpak/stable
+            sudo apt-get -qq update
+            sudo apt-get install -y ostree flatpak flatpak-builder
+
+      - run:
+          name: FLATPAK ⟹ Install flathub Runtime & SDK
+          working_directory: ~/repo/scripts/flatpak
+          command: source functions.sh && flatpak_install_runtime
+
+      - restore_cache:
+          name: PIP ⟹ Restore cache
+          keys:
+            - v3-pip-{{ checksum "scripts/flatpak/requirements.txt" }}
+
+      - run:
+          name: FLATPAK ⟹ Generate flatpak manifest
+          working_directory: ~/repo/scripts/flatpak
+          command: |
+            export BUILD_BRANCH=$CIRCLE_BRANCH
+            source functions.sh && flatpak_build_manifest
+
+      - save_cache:
+          name: PIP ⟹ Save cache
+          key: v3-pip-{{ checksum "scripts/flatpak/requirements.txt" }}
+          paths:
+            - ~/repo/scripts/flatpak/.venv
+
+      - restore_cache:
+          name: FLATPAK BUILD ⟹ Restore cache
+          keys:
+            - v2-flatpak-{{ checksum "scripts/flatpak/org.linux_show_player.LinuxShowPlayer.json" }}-{{ checksum "scripts/flatpak/python-modules.json" }}
+            - v2-flatpak-
+
+      - run:
+          name: FLATPAK BUILD ⟹ Build flatpak (no exit on error)
+          working_directory: ~/repo/scripts/flatpak
+          command: source functions.sh && flatpak_build_noexit
+
+      - save_cache:
+          name: FLATPAK BUILD ⟹ Save cache
+          key: v2-flatpak-{{ checksum "scripts/flatpak/org.linux_show_player.LinuxShowPlayer.json" }}-{{ checksum "scripts/flatpak/python-modules.json" }}
+          paths:
+            - ~/repo/scripts/flatpak/.flatpak-builder
+
+      - run:
+          name: FLATPAK BUILD ⟹ Check if build failed
+          working_directory: ~/repo/scripts/flatpak
+          command: source functions.sh && flatpak_build_noexit_check
+
+      - run:
+          name: FLATPAK ⟹ Bundle flatpak
+          working_directory: ~/repo/scripts/flatpak
+          command: |
+            export BUILD_BRANCH=$CIRCLE_BRANCH
+            source functions.sh && flatpak_bundle
+
+      - run:
+          name: RELEASE ⟹ Update CI release
+          working_directory: ~/repo/scripts/flatpak
+          command: |
+            TAG=ci-$CIRCLE_BRANCH
+            ARTIFACT_NAME="LinuxShowPlayer-$CIRCLE_BRANCH-x86_64.flatpak"
+
+            # Rename artifact
+            mv out/linux-show-player.flatpak "out/$ARTIFACT_NAME"
+
+            # Download helper for github releases
+            curl -O -L https://github.com/tcnksm/ghr/releases/download/v0.16.0/ghr_v0.16.0_linux_amd64.tar.gz
+            tar xvzf ghr_v0.16.0_linux_amd64.tar.gz --wildcards */ghr --strip-components=1
+
+            # Upload the artifacts
+            ./ghr \
+              -n "Automated build ($CIRCLE_BRANCH)" \
+              -b "Build number: $CIRCLE_BUILD_NUM<br>Completed at: $(date)" \
+              -c $CIRCLE_SHA1 \
+              -recreate \
+              -prerelease \
+              $TAG "out/$ARTIFACT_NAME"
+
+      - store_artifacts:
+          path: ~/repo/scripts/flatpak/out
+          destination: build
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-flatpak:
+          context: Github
+          filters:
+            branches:
+              only:
+                - master
+                - develop

.codacy.yml

@@ -0,0 +1,5 @@
+---
+engines:
+ pylint:
+   enabled: true
+   python_version: 3

.crowdin.yml

@@ -0,0 +1,3 @@
+files:
+  - source: /lisp/i18n/ts/en/*.ts
+    translation: /lisp/i18n/ts/%locale_with_underscore%/%original_file_name%

.readthedocs.yml

@@ -0,0 +1,12 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+python:
+  version: "3"
+  install:
+    - requirements: docs/user/requirements.txt
+
+sphinx:
+  configuration: docs/user/conf.py

README.md

@@ -1,40 +1,63 @@
-# Linux Show Player [![GitHub release](https://img.shields.io/github/release/FrancescoCeruti/linux-show-player.svg?maxAge=2592000)](https://github.com/FrancescoCeruti/linux-show-player/releases) [![Github All Releases](https://img.shields.io/github/downloads/FrancescoCeruti/linux-show-player/total.svg?maxAge=2592000)](https://github.com/FrancescoCeruti/linux-show-player/releases/) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/bef08c3ae14e4953962b7e4bc82a0c03)](https://www.codacy.com/app/ceppofrancy/linux-show-player?utm_source=github.com&utm_medium=referral&utm_content=FrancescoCeruti/linux-show-player&utm_campaign=Badge_Grade) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000)](https://gitter.im/linux-show-player/linux-show-player)
-Linux Show Player (LiSP) - Sound player designed for stage productions
+<p align="center">
+    <img src="https://github.com/FrancescoCeruti/linux-show-player/blob/develop/dist/linuxshowplayer.png?raw=true" alt="Logo" width="100" height=100>
+</p>
+<h1 align="center">Linux Show Player</h1>
+<h3 align="center">Cue player for stage productions</h3>
+
+<p align="center">
+    <a href="https://github.com/FrancescoCeruti/linux-show-player/blob/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/license-GPL-blue.svg"></a>
+    <a href="https://github.com/FrancescoCeruti/linux-show-player/releases/latest"><img src="https://img.shields.io/github/release/FrancescoCeruti/linux-show-player.svg?maxAge=2592000" alt="GitHub release" /></a>
+    <a href="https://github.com/FrancescoCeruti/linux-show-player/releases"><img src="https://img.shields.io/github/downloads/FrancescoCeruti/linux-show-player/total.svg?maxAge=2592000" alt="Github All Releases" /></a>
+    <a href="https://www.codacy.com/app/ceppofrancy/linux-show-player?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=FrancescoCeruti/linux-show-player&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/bef08c3ae14e4953962b7e4bc82a0c03" alt="Code Health" /></a>
+    <a href="https://gitter.im/linux-show-player/linux-show-player"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000" alt="Gitter" /></a>
+    <a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
+</p>
 
 ---
 
-Every component on which LiSP relies (python3, GStreamer and Qt5) is multi-platform, but the program is currently tested and developed only for **GNU/Linux**.
+Linux Show Player, LiSP for short, is a free cue player, primarily intended for sound-playback during stage productions. The ultimate goal is to provide a complete playback software for musical plays, theatre shows, and similar.
 
-No special hardware is required to run LiSP, but some processing operations would surely take benefit from a recent CPU.
-
-For bugs/requests an issue can be open on the GitHub issues-tracker, for everything else use the [discussions section](https://github.com/FrancescoCeruti/linux-show-player/discussions) or chat on [gitter](https://gitter.im/linux-show-player/linux-show-player).
+For bugs and requests you can open an issue on the GitHub issues tracker; for support, discussions, and anything else you should use the [gitter](https://gitter.im/linux-show-player/linux-show-player) chat.
 
 ---
 
 ### Installation
 
-#### AppImage
+Linux Show Player is currently developed on and tested for **GNU/Linux** only.<br>
+_The core components (Python3, GStreamer and Qt5) are multi-platform, thus in future - despite the name - LiSP might get ported to other platforms._
 
-You can download an [AppImage](http://appimage.org/) bundle of LiSP from the release page, once downloaded make the file executable.
-Now you should be able to run LiSP by double-clicking the file.
+#### 📦 Flatpak
 
-#### Distro Repository
+From version _0.6_ it will be possible to install a [Flatpak](https://flatpak.org/) package, follow the _simple_ instructions on their website to get everything ready. 
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/linux-show-player.svg)](https://repology.org/metapackage/linux-show-player)
+You can get the latest **development** builds here:
+ * [Master](https://github.com/FrancescoCeruti/linux-show-player/releases/tag/ci-master) - Generally stable
+ * [Development](https://github.com/FrancescoCeruti/linux-show-player/releases/tag/ci-develop) - Preview features, might be unstable and untested
 
-#### Manually
+#### 🐧 From your distribution repository
 
-Otherwise follow the instructions on the [wiki](https://github.com/FrancescoCeruti/linux-show-player/wiki/Install) to install it manually
+For some GNU/Linux distributions you can install a native package.<br>
+Keeping in mind that it might not be the latest version, you can find a list on [repology.org](https://repology.org/metapackage/linux-show-player).
 
 ---
 
-### Usage
+### 📖 Usage
+
+A user manual can be [viewed online](http://linux-show-player-users.readthedocs.io/en/latest/index.html) or downloaded from the [releases page](https://github.com/FrancescoCeruti/linux-show-player/releases) on GitHub.
+
+#### ⌨️ Command line:
 
-Use the installed launcher from the menu (for the package installation), or
+```
+usage: linux-show-player [-h] [-f [FILE]] [-l {debug,info,warning}]
+                         [--locale LOCALE]
 
-    $ linux-show-player                                  # Launch the program
-    $ linux-show-player -l [debug/warning/info]          # Launch with different log options
-    $ linux-show-player -f <file/path>                   # Open a saved session
-    $ linux-show-player --locale <locale>                # Launch using the given locale
+Cue player for stage productions.
 
-*User documentation downloaded under the GitHub release page or [viewed online](http://linux-show-player-users.readthedocs.io/en/latest/index.html)*
+optional arguments:
+  -h, --help            show this help message and exit
+  -f [FILE], --file [FILE]
+                        Session file to open
+  -l {debug,info,warning}, --log {debug,info,warning}
+                        Change output verbosity. default: warning
+  --locale LOCALE       Force specified locale/language
+```