{"id":13505583,"url":"https://github.com/beeware/briefcase-linux-appimage-template","last_synced_at":"2025-08-10T20:10:09.770Z","repository":{"id":38108758,"uuid":"226473496","full_name":"beeware/briefcase-linux-appimage-template","owner":"beeware","description":"A template for generating Linux AppImage projects with Briefcase","archived":false,"fork":false,"pushed_at":"2025-07-19T13:11:47.000Z","size":789,"stargazers_count":21,"open_issues_count":1,"forks_count":20,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-08-03T16:43:25.130Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beeware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["freakboy3742"],"custom":["http://beeware.org/bee/join"]}},"created_at":"2019-12-07T07:33:38.000Z","updated_at":"2025-07-19T21:05:13.000Z","dependencies_parsed_at":"2022-07-08T01:40:39.146Z","dependency_job_id":"55317d33-f0e9-4ae3-8975-7992b0f224a7","html_url":"https://github.com/beeware/briefcase-linux-appimage-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/beeware/briefcase-linux-appimage-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-appimage-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-appimage-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-appimage-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-appimage-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/briefcase-linux-appimage-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-appimage-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268603440,"owners_count":24276969,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T00:01:10.125Z","updated_at":"2025-08-10T20:10:09.757Z","avatar_url":"https://github.com/beeware.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/freakboy3742","http://beeware.org/bee/join"],"categories":["AppImage developer tools"],"sub_categories":["Templates"],"readme":"# Briefcase Linux AppImage Template\nA [Cookiecutter](https://github.com/cookiecutter/cookiecutter/) template for\nbuilding Python apps that will run under Linux, packaged as an AppImage.\n\n## Using this template\nThe easiest way to use this project is to not use it at all - at least, not\ndirectly. [Briefcase](https://github.com/beeware/briefcase/) is a tool that\nuses this template, rolling it out using data extracted from a `pyproject.toml` configuration file.\n\nHowever, if you *do* want use this template directly...\n\n1. Install [cookiecutter](https://github.com/cookiecutter/cookiecutter/). This is a tool used to bootstrap complex project templates:\n```\n    $ pip install cookiecutter\n```\n\n2. Run `cookiecutter` on the template:\n\n```\n    $ cookiecutter https://github.com/beeware/briefcase-linux-appimage-template\n```\n\u003cul\u003e\n   This will ask you for a number of details of your application, including the\n   `name` of your application (which should be a valid PyPI identifier), and\n   the `Formal Name` of your application (the full name you use to describe\n   your app). The remainder of these instructions will assume a `name` of\n   `my-project`, and a formal name of `My Project`.\n\u003c/ul\u003e\n\n3. [Obtain a Python Standalone Build for x86_64](https://github.com/astral-sh/python-build-standalone/releases), and extract it into\n   the `My Project/My Project.AppDir/usr` directory generated by the\n   template. This will give you a self-contained Python install. If installed\n   correctly, there should be a `My Project/My\n   Project.AppDir/usr/bin/python3` binary, as well as some other\n   Python-related files.\n\n4. Add your code to the template, into the `My Project/My Project.AppDir/usr/app`\n   directory. At the very minimum, you need to have an\n   `app/\u003capp name\u003e/__main__.py` file that defines an entry point that will\n   start your application.\n\n   If your code has any dependencies, they should be installed into the\n   `My Project/My Project.AppDir/usr/app_packages` directory.\n\nIf you've done this correctly, a project with a formal name of `My Project`,\nwith an app name of `my-project` should have a directory structure that\nlooks something like:\n```\n    My Project/\n        My Project.AppDir/\n            usr/\n                app/\n                    my_project/\n                        __init__.py\n                        __main__.py\n                        app.py\n                app_packages/\n                    ...\n                bin/\n                    python3\n                    ...\n                lib/\n                    ...\n                share/\n                    ...\n            com.example.my-project.desktop\n        briefcase.toml\n```\n\nThis directory can then be compiled into an AppImage using [linuxdeploy](https://github.com/linuxdeploy/linuxdeploy).\nDownload the [linuxdeploy AppImage](https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage), and make the binary executable:\n```\n    $ chmod +x linuxdeploy-x86_64.AppImage\n```\n\nThen compile your AppDir directory (substituting your release version number):\n```\n    $ VERSION=1.2.3 ./linuxdeploy-x86_64.AppImage --appdir=My\\ Project/My\\ Project.AppDir -o appimage -d My\\ Project/My\\ Project.AppDir/com.example.my-project.desktop\n```\nThis will produce `My Project-1.2.3-x86_64.AppImage`. This image can given\nto any other Linux user, and should run without installing any other\ndependencies.\n\n## Next steps\nOf course, running Python code isn't very interesting by itself.\n\nTo do something interesting, you'll need to work with the native system\nlibraries to draw widgets and respond to user input. The [GTK+](https://python-gtk-3-tutorial.readthedocs.io/) GUI library\nprovides Python bindings that you can use to build a user interface.\nAlternatively, you could use a cross-platform widget toolkit that supports\nWindows (such as [Toga](https://beeware.org/project/projects/libraries/toga)) to provide a GUI for your application.\n\nIf you have any external library dependencies (like Toga, or anything other\nthird-party library), you should install the library code into the\n`app_packages` directory. This directory is the same as a  `site_packages`\ndirectory on a desktop Python install.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-linux-appimage-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fbriefcase-linux-appimage-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-linux-appimage-template/lists"}