{"id":18838614,"url":"https://github.com/beeware/briefcase-linux-system-template","last_synced_at":"2025-04-14T06:23:35.102Z","repository":{"id":146881170,"uuid":"605401589","full_name":"beeware/briefcase-linux-system-template","owner":"beeware","description":"A template for generating Linux system packages with Briefcase","archived":false,"fork":false,"pushed_at":"2025-03-25T00:55:48.000Z","size":607,"stargazers_count":3,"open_issues_count":2,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-25T01:32:44.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","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.rst","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},"funding":{"github":["freakboy3742"],"custom":["http://beeware.org/bee/join"]}},"created_at":"2023-02-23T04:22:34.000Z","updated_at":"2025-03-25T00:55:54.000Z","dependencies_parsed_at":"2023-11-18T03:28:30.049Z","dependency_job_id":"b894d1d8-0fb6-4f72-8e1d-62c04a0bb983","html_url":"https://github.com/beeware/briefcase-linux-system-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-system-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-system-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-system-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-linux-system-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/briefcase-linux-system-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248831301,"owners_count":21168441,"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","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-11-08T02:40:01.731Z","updated_at":"2025-04-14T06:23:35.068Z","avatar_url":"https://github.com/beeware.png","language":"C","funding_links":["https://github.com/sponsors/freakboy3742","http://beeware.org/bee/join"],"categories":[],"sub_categories":[],"readme":"Briefcase Linux System App Template\n===================================\n\nA `Cookiecutter \u003chttps://github.com/cookiecutter/cookiecutter/\u003e`__ template for\nbuilding Python apps that will run under Linux, packaged as native system\npackages.\n\nUsing this template\n-------------------\n\nThe easiest way to use this project is to not use it at all - at least, not\ndirectly. `Briefcase \u003chttps://github.com/beeware/briefcase/\u003e`__ is a tool that\nuses this template, rolling it out using data extracted from a\n``pyproject.toml`` configuration file.\n\nHowever, if you *do* want use this template directly...\n\n1. Install `cookiecutter`_. This is a tool used to bootstrap complex project\n   templates::\n\n    $ pip install cookiecutter\n\n2. Run ``cookiecutter`` on the template::\n\n    $ cookiecutter https://github.com/beeware/briefcase-linux-system-template\n\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\n3. Add your code to the template, into the ``My\n   Project/project/usr/local/share/my_project`` directory. At\n   the very minimum, you need to have an ``app/\u003capp name\u003e/__main__.py`` file\n   that defines an entry point that will start your application.\n\n   If your code has any dependencies, they should be installed into the\n   ``My\n   Project/project/usr/local/lib/my_project/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        bootstrap/\n            main.c\n            Makefile\n        project/\n            usr/\n                lib/\n                    my-project/\n                        app/\n                            my_project/\n                                __init__.py\n                                __main__.py\n                                app.py\n                        app_packages/\n                            ...\n                share/\n                    applications/\n                        com.example.my-project.desktop\n                    icons/\n                        ...\n        Dockerfile\n        briefcase.toml\n\n4. Compile and install the bootstrap binary::\n\n    $ cd \"My Project\"\n    $ make -C bootstrap install\n\n6. Build the DEB package::\n\n    $ dpkg-deb --build --root-owner-group project\n\nThis will project a ``project.deb`` file that you can install with::\n\n    $ sudo apt install -f project.deb\n\nNext steps\n----------\n\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+`_ 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`_) 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\n.. _cookiecutter: https://github.com/cookiecutter/cookiecutter\n.. _Obtain a Python Linux support package for x86_64: https://github.com/beeware/Python-Linux-support\n.. _Toga: https://beeware.org/project/projects/libraries/toga\n.. _GTK+: https://python-gtk-3-tutorial.readthedocs.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-linux-system-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fbriefcase-linux-system-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-linux-system-template/lists"}