A Program to create Snapshots of Flatpak Apps
Go to file
JakobDev 1e286e48dc Merge pull request 'Translations update from Weblate' (#9) from translate/jdFlatpakSnapshot:weblate-jdFlatpakSnapshot-jdFlatpakSnapshot into main
Reviewed-on: #9
2023-08-13 21:57:56 +00:00
.woodpecker Prepare new Release 2023-06-01 08:18:55 +02:00
deploy Prepare new Release 2023-06-01 08:18:55 +02:00
jdFlatpakSnapshot Translated using Weblate (Ukrainian) 2023-08-13 19:53:03 +00:00
screenshots Update Screenshot 2023-04-18 10:47:32 +02:00
tools Add Ukrainian and Russian Language 2023-05-22 16:24:12 +02:00
.editorconfig Init 2023-04-05 16:05:45 +02:00
.gitattributes Add .gitattributes 2023-04-18 09:43:08 +02:00
.gitignore Init 2023-04-05 16:05:45 +02:00
BuildBackend.py Init 2023-04-05 16:05:45 +02:00
LICENSE Init 2023-04-05 16:05:45 +02:00
MANIFEST.in Add ui to include 2023-04-10 16:53:57 +02:00
README.md Update Readme 2023-04-18 09:12:50 +02:00
install-unix-datafiles.py Init 2023-04-05 16:05:45 +02:00
jdFlatpakSnapshot.py Init 2023-04-05 16:05:45 +02:00
pyproject.toml Prepare new Release 2023-06-01 08:18:55 +02:00

README.md

jdFlatpakSnapshot

A Program to create Snapshots of Flatpak Apps

jdFlatpakSnapshot

jdFlatpakSnapshot allows you to easily create. a Snapshot of all the Data of a Flatpak. You can now play around and change the settings of the Flatpak or something else. If something goes wrong, you can restore the Data from the Snapshot with one click.

Install

Flatpak

You can get jdFlatpakSnapshot from Flathub

pip

You can install jdFlatpakSnapshot from PyPI using pip:

pip install jdFlatpakSnapshot

Using this Method, it will not include a Desktop Entry or any other Data file, so you need to run jdFlatpakSnapshot from the Command Line. Use this only, when nothing else works.

From source

This is only for experienced Users and someone, who wants to package jdFlatpakSnapshot for a Distro. jdFlatpak should be installed as a Python package. You can use pip or any other tool that can handle Python packages. YOu need to have lrelease installed to build the Package. After that, you should run install-unix-datafiles.py which wil install things like the Desktop Entry or the Icon in the correct place. It defaults to /usr, but you can change it with the --prefix argument. It also applies the translation to this files. You need gettext installed to run install-unix-datafiles.py.

Here's a example of installing jdFlatpakSnapshot into /usr/local:

sudo pip install --prefix /usr/local .
sudo ./install-unix-datafiles.py --prefix /usr/local

Translate

You can help translating jdFlatpakSnapshot on Codeberg Translate

Develop

jdFlatpak is written in Python and uses PyQt6 as GUI toolkit. You should have some experience in both. You can run jdFlatpakSnapshot.pyto start jdFlatpakSnapshot from source and test your local changes. It ships with a few scripts in the tools directory that you need to develop.

CompileUI.py

This is the most important script. It will take all .ui files in jdFlatpakSnapshot/ui and compiles it to a Python class and stores it in jdFlatpakSnapshot/ui_compiled. Without running this script first, you can't start jdFlatpakSnapshot. You need to rerun it every time you changed or added a .ui file.

BuildTranslations.py

This script takes all .ts files and compiles it to .qm files. The .ts files are containing the translation source and are being used during the translation process. The .qm contains the compiled translation and are being used by the Program. You need to compile a .ts file to a .qm file to see the translations in the Program.

UpdateTranslations.py

This regenerates the .ts files. You need to run it, when you changed something in the source code. The .ts files are contains the line in the source, where the string to translate appears, so make sure you run it even when you don't changed a translatable string, so the location is correct.

UpdateUnixDataTranslations.py

This regenerates the translation files in deploy/translations. these files contains the translations for the Desktop Entry and the AppStream File. It uses gettext, as it is hard to translate this using Qt. These files just exists to integrate the translation with Weblate, because Weblate can't translate the Desktop Entry and the AppStream file. Make sure you run this when you edited one of these files. YOu need to have gettext installed to use it.

UpdateTranslators.py

This uses git to get a list of all Translators and writes it to jdFlatpakSnapshot/data/translators.json. This is used to display the translators in the About Dialog. You need git to run this script.

WriteChangelogHtml.py

This read the Changelog from deploy/page.codeberg.JakobDev.jdFlatpakSnapshot.metainfo.xml, converts it to HTML and writes it to jdFlatpakSnapshot/data/changelog.html. This is used to display the Changelog in the About Dialog. You need appstream-python to be installed to use this script.