index.rst

Briefcase

Briefcase is a tool for converting a Python project into a standalone native application. It supports producing binaries for:

• macOS, as a standalone .app
• Windows, as an MSI installer
• Linux, as an AppImage
• iOS, as an Xcode project
• Android, as a Gradle project
• the Web, as a static web site using PyScript for client-side Python

It is also extensible, allowing for additional platforms and installation formats to be produced.

Table of contents

:ref:`Tutorial <tutorial>`

Get started with a hands-on introduction for beginners.

:ref:`How-to guides <how-to>`

Guides and recipes for common problems and tasks, including how to contribute.

:ref:`Background <background>`

Explanation and discussion of key topics and concepts.

:ref:`Reference <reference>`

Technical reference - commands, modules, classes, methods.

Community

Briefcase is part of the BeeWare suite. You can talk to the community through:

• @[email protected] on Mastodon
• Discord
• The Briefcase Github Discussions forum

.. toctree::
   :maxdepth: 2
   :hidden:
   :titlesonly:

   tutorial/index
   how-to/index
   background/index
   reference/index