| Name | pyproject-appimage JSON |
| Version |
3.1
JSON |
| download |
| home_page | |
| Summary | Generate AppImages from your Python projects |
| upload_time | 2023-12-13 10:08:26 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | BSD-2-Clause |
| keywords |
jakobdev
appimage
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyproject-appimage
pyproject-appimage allows you to create a AppImage in a few seconds. To get started, just add this to your pyproject.toml:
```toml
[tool.pyproject-appimage]
script = "my-app"
output = "MyApp.AppImage"
```
`script` is here the script that should be run when executing the AppImage. You can use the `project.scripts` section of your pyproject.toml or the `entry_points` argument of your setup.py to create scripts.
To create a AppImage, just run this command in your project directory:
```
pyproject-appimage
```
## Pyproject options
The following options can be used in your pyproject.toml:
| Option | Type |Description |
| ------ | ------ | ------ |
| script | string | The script that should be run |
| output | string | The filename of your AppImage. Can be overwritten with the cli. |
| icon | string | The path to your Icon |
| rename-icon | string | Give your Icon another name inside the AppImage |
| desktop-entry | string | The path to your .desktop file |
| rename-desktop-entry | string | Give your .desktop file another name inside the AppImage |
| gettext-desktop-entry | bool | If your .desktop file should be translated using gettest |
| appstream | string | The path to your AppStream file |
| rename-appstream | string | Give your AppStream file another name inside the AppImage |
| gettext-appstream | bool | If your AppStream file should be translated using gettest |
| gettext-directory | string | The path to your gettext directory |
| python-version | string | The Python version that is used. Default is your current version. Can be overwritten with the cli. |
| updateinformation | string | The [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information)
| compression | string | The Squashfs compression
Note: All paths are relativ to your project directory
## Cli options
pyproject-appimage provides the following cli options:
```
usage: pyproject-appimage [-h] [--output OUTPUT] [--project-dir PROJECT_DIR] [--python-version PYTHON_VERSION] [--appimagekit-url APPIMAGEKIT_URL] [--work-dir WORK_DIR]
[--list-available-versions] [--no-fuse] [-v]
options:
-h, --help show this help message and exit
--output OUTPUT Sets the putput filename
--project-dir PROJECT_DIR
Sets the project dir
--python-version PYTHON_VERSION
Set a custom Python version
--appimagekit-url APPIMAGEKIT_URL
Set a custom download URL for AppImageKit
--work-dir WORK_DIR Set a custom directory to work in. Existing Directories will be removed.
--list-available-versions
Print available Python versions and exit
--no-fuse Use this, if FUSE is not available e.g. inside a Docker container
-v, --version Prints the version and exit
```
## Projects using pyproject-appimage
* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)
[pyproject-appimage is of course also available as AppImage](https://codeberg.org/JakobDev/pyproject-appimage/releases/latest)
pyproject-appimage is based [on the work of niess](https://github.com/niess/python-appimage)
Raw data
{
"_id": null,
"home_page": "",
"name": "pyproject-appimage",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "JakobDev,AppImage",
"author": "",
"author_email": "JakobDev <jakobdev@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/b4/33/70e9d31b600a0829ef6eb21622f8f76093e492f0b49f62f430cab1378c15/pyproject-appimage-3.1.tar.gz",
"platform": null,
"description": "# pyproject-appimage\n\n\n\n\n\npyproject-appimage allows you to create a AppImage in a few seconds. To get started, just add this to your pyproject.toml:\n\n```toml\n[tool.pyproject-appimage]\nscript = \"my-app\"\noutput = \"MyApp.AppImage\"\n```\n`script` is here the script that should be run when executing the AppImage. You can use the `project.scripts` section of your pyproject.toml or the `entry_points` argument of your setup.py to create scripts.\n\nTo create a AppImage, just run this command in your project directory:\n```\npyproject-appimage\n```\n\n## Pyproject options\nThe following options can be used in your pyproject.toml:\n\n| Option | Type |Description |\n| ------ | ------ | ------ |\n| script | string | The script that should be run |\n| output | string | The filename of your AppImage. Can be overwritten with the cli. |\n| icon | string | The path to your Icon |\n| rename-icon | string | Give your Icon another name inside the AppImage |\n| desktop-entry | string | The path to your .desktop file |\n| rename-desktop-entry | string | Give your .desktop file another name inside the AppImage |\n| gettext-desktop-entry | bool | If your .desktop file should be translated using gettest |\n| appstream | string | The path to your AppStream file |\n| rename-appstream | string | Give your AppStream file another name inside the AppImage |\n| gettext-appstream | bool | If your AppStream file should be translated using gettest |\n| gettext-directory | string | The path to your gettext directory |\n| python-version | string | The Python version that is used. Default is your current version. Can be overwritten with the cli. |\n| updateinformation | string | The [update information](https://github.com/AppImage/AppImageSpec/blob/master/draft.md#update-information)\n| compression | string | The Squashfs compression\n\nNote: All paths are relativ to your project directory\n\n## Cli options\npyproject-appimage provides the following cli options:\n```\nusage: pyproject-appimage [-h] [--output OUTPUT] [--project-dir PROJECT_DIR] [--python-version PYTHON_VERSION] [--appimagekit-url APPIMAGEKIT_URL] [--work-dir WORK_DIR]\n [--list-available-versions] [--no-fuse] [-v]\n\noptions:\n -h, --help show this help message and exit\n --output OUTPUT Sets the putput filename\n --project-dir PROJECT_DIR\n Sets the project dir\n --python-version PYTHON_VERSION\n Set a custom Python version\n --appimagekit-url APPIMAGEKIT_URL\n Set a custom download URL for AppImageKit\n --work-dir WORK_DIR Set a custom directory to work in. Existing Directories will be removed.\n --list-available-versions\n Print available Python versions and exit\n --no-fuse Use this, if FUSE is not available e.g. inside a Docker container\n -v, --version Prints the version and exit\n```\n\n## Projects using pyproject-appimage\n* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)\n\n[pyproject-appimage is of course also available as AppImage](https://codeberg.org/JakobDev/pyproject-appimage/releases/latest)\n\npyproject-appimage is based [on the work of niess](https://github.com/niess/python-appimage)\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Generate AppImages from your Python projects",
"version": "3.1",
"project_urls": {
"Donation": "https://ko-fi.com/jakobdev",
"Downloads": "https://codeberg.org/JakobDev/pyproject-appimage/releases",
"Issues": "https://codeberg.org/JakobDev/pyproject-appimage/issues",
"Source": "https://codeberg.org/JakobDev/pyproject-appimage"
},
"split_keywords": [
"jakobdev",
"appimage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f415a177298c91a488ef5f3972948027f72a967a393e618ead3deb8e495da88",
"md5": "24ceeeef86d586875514a66754c31b57",
"sha256": "c700239e543b41aa3d77b1e5a8b39f4e5a47ec1ddb81a6844978ca8bf025b4db"
},
"downloads": -1,
"filename": "pyproject_appimage-3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24ceeeef86d586875514a66754c31b57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 37188,
"upload_time": "2023-12-13T10:08:24",
"upload_time_iso_8601": "2023-12-13T10:08:24.565179Z",
"url": "https://files.pythonhosted.org/packages/5f/41/5a177298c91a488ef5f3972948027f72a967a393e618ead3deb8e495da88/pyproject_appimage-3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b43370e9d31b600a0829ef6eb21622f8f76093e492f0b49f62f430cab1378c15",
"md5": "d5fac1111905d735f7ecb1255cda5dfa",
"sha256": "ed84a6a6b9e09a090c69d178ce389905e4ac80d063cf3cd851723854863f2ab8"
},
"downloads": -1,
"filename": "pyproject-appimage-3.1.tar.gz",
"has_sig": false,
"md5_digest": "d5fac1111905d735f7ecb1255cda5dfa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 38878,
"upload_time": "2023-12-13T10:08:26",
"upload_time_iso_8601": "2023-12-13T10:08:26.619000Z",
"url": "https://files.pythonhosted.org/packages/b4/33/70e9d31b600a0829ef6eb21622f8f76093e492f0b49f62f430cab1378c15/pyproject-appimage-3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-13 10:08:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "JakobDev",
"codeberg_project": "pyproject-appimage",
"lcname": "pyproject-appimage"
}
