pyproject-appimage


Namepyproject-appimage JSON
Version 4.1 PyPI version JSON
download
home_pageNone
SummaryGenerate AppImages from your Python projects
upload_time2025-02-05 22:42:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD-2-Clause
keywords jakobdev appimage
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyproject-appimage

![PyPI - License](https://img.shields.io/pypi/l/pyproject-appimage)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyproject-appimage)
![PyPI - Downloads](https://img.shields.io/pypi/dm/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
| additional-packages | list of strins | A list of packages that should also be installed

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
* [jdMinecraftLauncher](https://codeberg.org/JakobDev/jdMinecraftLauncher)
* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)
* [jdReplace](https://codeberg.org/JakobDev/jdReplace)
* [jdMrpackInstaller](https://codeberg.org/JakobDev/jdMrpackInstaller)
* [jdDesktopEntryEdit](https://codeberg.org/JakobDev/jdDesktopEntryEdit)
* [jdAppStreamEdit](https://codeberg.org/JakobDev/jdAppStreamEdit)

[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": null,
    "name": "pyproject-appimage",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "JakobDev, AppImage",
    "author": null,
    "author_email": "JakobDev <jakobdev@gmx.de>",
    "download_url": "https://files.pythonhosted.org/packages/fc/d4/f5826c203705138174f8a9051134ad9d6c9dc176942106d56b68d9eac6ba/pyproject_appimage-4.1.tar.gz",
    "platform": null,
    "description": "# pyproject-appimage\n\n![PyPI - License](https://img.shields.io/pypi/l/pyproject-appimage)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyproject-appimage)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/pyproject-appimage)\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| additional-packages | list of strins | A list of packages that should also be installed\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* [jdMinecraftLauncher](https://codeberg.org/JakobDev/jdMinecraftLauncher)\n* [jdNBTExplorer](https://codeberg.org/JakobDev/jdNBTExplorer)\n* [jdReplace](https://codeberg.org/JakobDev/jdReplace)\n* [jdMrpackInstaller](https://codeberg.org/JakobDev/jdMrpackInstaller)\n* [jdDesktopEntryEdit](https://codeberg.org/JakobDev/jdDesktopEntryEdit)\n* [jdAppStreamEdit](https://codeberg.org/JakobDev/jdAppStreamEdit)\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": "4.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": null,
            "digests": {
                "blake2b_256": "f45cc23bc853032d50e1cb1e88f5dcf34c52c19ae3d13d29d2eba9d2de34ff28",
                "md5": "4696f8f557f8f4440fc1feec587f8827",
                "sha256": "5be6bcd506955f0f065e77cf8cb1b14766872935363d3b19d92f7eedd6e04ca0"
            },
            "downloads": -1,
            "filename": "pyproject_appimage-4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4696f8f557f8f4440fc1feec587f8827",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 37407,
            "upload_time": "2025-02-05T22:42:11",
            "upload_time_iso_8601": "2025-02-05T22:42:11.059894Z",
            "url": "https://files.pythonhosted.org/packages/f4/5c/c23bc853032d50e1cb1e88f5dcf34c52c19ae3d13d29d2eba9d2de34ff28/pyproject_appimage-4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fcd4f5826c203705138174f8a9051134ad9d6c9dc176942106d56b68d9eac6ba",
                "md5": "51f79d1626f9a7bd529a57d2ec5931dd",
                "sha256": "45e6a72d3e3aa8d31de524dc76d132a467aa3ba845ecbe3dc4c2fd5fd6d37967"
            },
            "downloads": -1,
            "filename": "pyproject_appimage-4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "51f79d1626f9a7bd529a57d2ec5931dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 39432,
            "upload_time": "2025-02-05T22:42:12",
            "upload_time_iso_8601": "2025-02-05T22:42:12.432827Z",
            "url": "https://files.pythonhosted.org/packages/fc/d4/f5826c203705138174f8a9051134ad9d6c9dc176942106d56b68d9eac6ba/pyproject_appimage-4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-05 22:42:12",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": true,
    "codeberg_user": "JakobDev",
    "codeberg_project": "pyproject-appimage",
    "lcname": "pyproject-appimage"
}
        
Elapsed time: 0.63957s