| Name | jdAppStreamEdit JSON |
| Version |
8.0
JSON |
| download |
| home_page | |
| Summary | A graphical Program to create and edit AppStream files |
| upload_time | 2023-12-22 17:41:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | GPL-3 |
| keywords |
jakobdev
linux
freedesktop
appstream
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">jdAppStreamEdit</h1>
<h3 align="center">A graphical Program to create and edit AppStream files</h3>
<p align="center">
<img alt="jdAppStreamEdit" src="screenshots/GeneralTab.png"/>
</p>
jdAppStreamEdit (previously known as jdAppdataEdit) allows you to easily create and edit AppStream (.appdata.xml or .metainfo.xml) files for your Application.
Features:
- Easy to use
- Full support for the Open Age Rating System (OARS)
- The AppStream files are fully translatable
- Releases can be imported from GitHub, GitLab, Gitea, Git Repos and NEWS files
- You can view a preview in Gnome Software
- You can use a existing .desktop file as template
- Plugins
## Install
### Flatpak
You can get jdAppStreamEdit from [Flathub](https://flathub.org/apps/details/page.codeberg.JakobDev.jdAppStreamEdit)
### AUR
Arch Users can get jdAppStreamEdit from the [AUR](https://aur.archlinux.org/packages/jdappstreamedit)
### Sourceforge
You can get Windows and AppImage Builds from [Sourceforge](https://sourceforge.net/projects/jdappstreamedit)
### pip
You can install jdAppStreamEdit from [PyPI](https://pypi.org/project/jdAppStreamEdit) using `pip`:
```shell
pip install jdAppStreamEdit
```
Using this Method, it will not include a Desktop Entry or any other Data file, so you need to run jdAppStreamEdit 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 jdAppStreamEdit for a Distro.
jdAppStreamEdit 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 jdAppStreamEdit into `/usr/local`:
```shell
sudo pip install --prefix /usr/local .
sudo ./install-unix-datafiles.py --prefix /usr/local
```
## Translate
You can help translating jdAppStreamEdit on [Codeberg Translate](https://translate.codeberg.org/projects/jdAppStreamEdit)
## Develop
jdAppStreamEdit is written in Python and uses PyQt6 as GUI toolkit. You should have some experience in both.
You can run `jdAppStreamEdit.py`to start jdAppStreamEdit 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 `jdAppStreamEdit/ui` and compiles it to a Python class
and stores it in `jdAppStreamEdit/ui_compiled`. Without running this script first, you can't start jdAppStreamEdit.
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 `jdAppStreamEdit/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.jdAppStreamEdit.metainfo.xml`, converts it to HTML and writes it to `jdAppStreamEdit/data/changelog.html`.
This is used to display the Changelog in the About Dialog.
You need [appstream-python](https://pypi.org/project/appstream-python) to be installed to use this script.
Raw data
{
"_id": null,
"home_page": "",
"name": "jdAppStreamEdit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "JakobDev,Linux,Freedesktop,AppStream",
"author": "",
"author_email": "JakobDev <jakobdev@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/bf/1b/11426210a7620768588fa32b4387f44100c9a3978a5e207e0c87d8344e13/jdAppStreamEdit-8.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">jdAppStreamEdit</h1>\n\n<h3 align=\"center\">A graphical Program to create and edit AppStream files</h3>\n\n<p align=\"center\">\n <img alt=\"jdAppStreamEdit\" src=\"screenshots/GeneralTab.png\"/>\n</p>\n\njdAppStreamEdit (previously known as jdAppdataEdit) allows you to easily create and edit AppStream (.appdata.xml or .metainfo.xml) files for your Application.\n\nFeatures:\n- Easy to use\n- Full support for the Open Age Rating System (OARS)\n- The AppStream files are fully translatable\n- Releases can be imported from GitHub, GitLab, Gitea, Git Repos and NEWS files\n- You can view a preview in Gnome Software\n- You can use a existing .desktop file as template\n- Plugins\n\n## Install\n\n### Flatpak\nYou can get jdAppStreamEdit from [Flathub](https://flathub.org/apps/details/page.codeberg.JakobDev.jdAppStreamEdit)\n\n### AUR\nArch Users can get jdAppStreamEdit from the [AUR](https://aur.archlinux.org/packages/jdappstreamedit)\n\n### Sourceforge\nYou can get Windows and AppImage Builds from [Sourceforge](https://sourceforge.net/projects/jdappstreamedit)\n\n### pip\nYou can install jdAppStreamEdit from [PyPI](https://pypi.org/project/jdAppStreamEdit) using `pip`:\n```shell\npip install jdAppStreamEdit\n```\nUsing this Method, it will not include a Desktop Entry or any other Data file, so you need to run jdAppStreamEdit from the Command Line.\nUse this only, when nothing else works.\n\n#### From source\nThis is only for experienced Users and someone, who wants to package jdAppStreamEdit for a Distro.\njdAppStreamEdit should be installed as a Python package.\nYou can use `pip` or any other tool that can handle Python packages.\nYou need to have `lrelease` installed to build the Package.\nAfter that, you should run `install-unix-datafiles.py` which wil install things like the Desktop Entry or the Icon in the correct place.\nIt defaults to `/usr`, but you can change it with the `--prefix` argument.\nIt also applies the translation to this files.\nYou need gettext installed to run `install-unix-datafiles.py`.\n\nHere's a example of installing jdAppStreamEdit into `/usr/local`:\n```shell\nsudo pip install --prefix /usr/local .\nsudo ./install-unix-datafiles.py --prefix /usr/local\n```\n\n## Translate\nYou can help translating jdAppStreamEdit on [Codeberg Translate](https://translate.codeberg.org/projects/jdAppStreamEdit)\n\n## Develop\njdAppStreamEdit is written in Python and uses PyQt6 as GUI toolkit. You should have some experience in both.\nYou can run `jdAppStreamEdit.py`to start jdAppStreamEdit from source and test your local changes.\nIt ships with a few scripts in the tools directory that you need to develop.\n\n#### CompileUI.py\nThis is the most important script. It will take all `.ui` files in `jdAppStreamEdit/ui` and compiles it to a Python class\nand stores it in `jdAppStreamEdit/ui_compiled`. Without running this script first, you can't start jdAppStreamEdit.\nYou need to rerun it every time you changed or added a `.ui` file.\n\n#### BuildTranslations.py\nThis script takes all `.ts` files and compiles it to `.qm` files.\nThe `.ts` files are containing the translation source and are being used during the translation process.\nThe `.qm` contains the compiled translation and are being used by the Program.\nYou need to compile a `.ts` file to a `.qm` file to see the translations in the Program.\n\n#### UpdateTranslations.py\nThis regenerates the `.ts` files. You need to run it, when you changed something in the source code.\nThe `.ts` files are contains the line in the source, where the string to translate appears,\nso make sure you run it even when you don't changed a translatable string, so the location is correct.\n\n#### UpdateUnixDataTranslations.py\nThis regenerates the translation files in `deploy/translations`. these files contains the translations for the Desktop Entry and the AppStream File.\nIt uses gettext, as it is hard to translate this using Qt.\nThese files just exists to integrate the translation with Weblate, because Weblate can't translate the Desktop Entry and the AppStream file.\nMake sure you run this when you edited one of these files.\nYOu need to have gettext installed to use it.\n\n#### UpdateTranslators.py\nThis uses git to get a list of all Translators and writes it to `jdAppStreamEdit/data/translators.json`.\nThis is used to display the translators in the About Dialog.\nYou need git to run this script.\n\n#### WriteChangelogHtml.py\nThis read the Changelog from `deploy/page.codeberg.JakobDev.jdAppStreamEdit.metainfo.xml`, converts it to HTML and writes it to `jdAppStreamEdit/data/changelog.html`.\nThis is used to display the Changelog in the About Dialog.\nYou need [appstream-python](https://pypi.org/project/appstream-python) to be installed to use this script.\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "A graphical Program to create and edit AppStream files",
"version": "8.0",
"project_urls": {
"Donation": "https://ko-fi.com/jakobdev",
"Issues": "https://codeberg.org/JakobDev/jdAppStreamEdit/issues",
"Source": "https://codeberg.org/JakobDev/jdAppStreamEdit",
"Translate": "https://translate.codeberg.org/projects/jdAppStreamEdit"
},
"split_keywords": [
"jakobdev",
"linux",
"freedesktop",
"appstream"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0233655afa4dec26d39f0c6521b894e165fea98a0fd94a731a1b5d314c216989",
"md5": "24d678068492ff9dbbe6dd7b27b7b892",
"sha256": "74acc605dc86d13f9395659df129d0daf0b3240c065663fb1f43a0b566878ee3"
},
"downloads": -1,
"filename": "jdAppStreamEdit-8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24d678068492ff9dbbe6dd7b27b7b892",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 199951,
"upload_time": "2023-12-22T17:41:08",
"upload_time_iso_8601": "2023-12-22T17:41:08.280530Z",
"url": "https://files.pythonhosted.org/packages/02/33/655afa4dec26d39f0c6521b894e165fea98a0fd94a731a1b5d314c216989/jdAppStreamEdit-8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf1b11426210a7620768588fa32b4387f44100c9a3978a5e207e0c87d8344e13",
"md5": "693a0397e01ee3503a8818aad9f0b6e4",
"sha256": "099d456d4b2820cabd0f95ec0e5a560d8a8cd797a1db02ad3543999d6d82cf85"
},
"downloads": -1,
"filename": "jdAppStreamEdit-8.0.tar.gz",
"has_sig": false,
"md5_digest": "693a0397e01ee3503a8818aad9f0b6e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 150373,
"upload_time": "2023-12-22T17:41:10",
"upload_time_iso_8601": "2023-12-22T17:41:10.064162Z",
"url": "https://files.pythonhosted.org/packages/bf/1b/11426210a7620768588fa32b4387f44100c9a3978a5e207e0c87d8344e13/jdAppStreamEdit-8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-22 17:41:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "JakobDev",
"codeberg_project": "jdAppStreamEdit",
"lcname": "jdappstreamedit"
}
