https://github.com/beeware/briefcase-linux-flatpak-template

A template for generating Linux Flatpak projects with Briefcase.
https://github.com/beeware/briefcase-linux-flatpak-template

Last synced: 3 months ago
JSON representation

A template for generating Linux Flatpak projects with Briefcase.

• Host: GitHub
• URL: https://github.com/beeware/briefcase-linux-flatpak-template
• Owner: beeware
• License: mit
• Created: 2022-07-26T01:12:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T02:37:50.000Z (3 months ago)
• Last Synced: 2024-10-27T03:34:58.605Z (3 months ago)
• Language: C
• Size: 607 KB
• Stars: 3
• Watchers: 7
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Briefcase Linux Flatpak Template

================================

A `Cookiecutter `__ template for

building Python apps that will run under Linux, packaged as a `Flatpak`_.

Using this template

-------------------

The easiest way to use this project is to not use it at all - at least, not

directly. `Briefcase `__ is a tool that

uses this template, rolling it out using data extracted from a

``pyproject.toml`` configuration file.

However, if you *do* want use this template directly...

1. Install `cookiecutter`_. This is a tool used to bootstrap complex project

   templates::

    $ pip install cookiecutter

2. Run ``cookiecutter`` on the template::

    $ cookiecutter https://github.com/beeware/briefcase-linux-appimage-template

   This will ask you for a number of details of your application, including the

   `name` of your application (which should be a valid PyPI identifier), and

   the `Formal Name` of your application (the full name you use to describe

   your app). The remainder of these instructions will assume a `name` of

   ``my-project``, and a formal name of ``My Project``.

3. `Download an official Python source tarball`_, and place it in the ``My

   Project`` directory generated by the template.

4. Add your code to the template, into the ``My Project/src/app``

   directory. At the very minimum, you need to have an

   ``app//__main__.py`` file that defines an entry point that will

   start your application.

5. Add a `requirements.txt` file in the root of your project, adding any

   dependencies of your application.

If you've done this correctly, a project with a formal name of ``My Project``,

with an app name of ``my-project`` using Python 3.10.6 should have a directory

structure that looks something like::

    My Project/

        icons/

            ...

        src/

            app/

                my_project/

                    __init__.py

                    __main__.py

                    app.py

        bootstrap

        briefcase.toml

        com.example.my-project.desktop

        manifest.yml

        requirements.txt

        Python-3.10.6.tgz

This directory can then be compiled using ``flatpak-builder``::

    $ flatpak-builder --force-clean --install --user build manifest.yml

This will build and install the flatpak into your user flatpak store.

The app can then be run with::

    $ flatpak run com.example.my-project

Next steps

----------

Of course, running Python code isn't very interesting by itself.

To do something interesting, you'll need to work with the native system

libraries to draw widgets and respond to user input. The `GTK+`_ GUI library

provides Python bindings that you can use to build a user interface.

Alternatively, you could use a cross-platform widget toolkit that supports

Windows (such as `Toga`_) to provide a GUI for your application.

If you have any external library dependencies (like Toga, or anything other

third-party library), you should install the library code into the

``app_packages`` directory. This directory is the same as a  ``site_packages``

directory on a desktop Python install.

.. _cookiecutter: https://github.com/cookiecutter/cookiecutter

.. _Flatpak: https://flatpak.org/

.. _Download an official Python source tarball: https://www.python.org/downloads/source/

.. _Toga: https://beeware.org/project/projects/libraries/toga

.. _GTK+: https://python-gtk-3-tutorial.readthedocs.io/