Skip to content

document how to create a standalone application #2757

Description

@davidism

Investigate and document how to package a Click project with Briefcase so that it becomes a standalone executable that does not require installing Python or dependencies.

Activity

  1. added
    docsUpdates to documentation, readme, docstrings, typos
    on Jul 31, 2024
  2. john0isaac commented on Aug 11, 2024

    @john0isaac
    Contributor

    I have a click package and wanted to help, this is all I needed to do in order for me to package it with briefcase.

    • Just add Briefcase setup to the pyproject.toml
    • Create __main__.py and execute the main function in it as they rely on it.
    • Run briefcase dev -- arg1 arg2 ... to test the package.
    • Run briefcase create to download and install required packages.
    • Run briefcase package to produce the executable.

    These are the changes I needed to do:
    https://github.com/john0isaac/markdown-checker/pull/68/files

    Happy to raise a PR to document it.

  3. davidism commented on Aug 13, 2024

    @davidism
    MemberAuthor

    Sure, check out Flask's deploying docs for an idea of the format and level of detail that might be appropriate. Like those docs, we'd eventually want different pages for different common tools, such as pyinstaller or cx_freeze. Not saying you need to be the one to write all those though, I'd be happy with briefcase only at this point.

  4. ofek commented on Sep 29, 2024

    @ofek
    Contributor

    In case it helps, I wrote PyApp to easily distribute Python applications (mostly CLIs) https://github.com/ofek/pyapp

  5. added this to the 8.3.3 milestone on Apr 19, 2026
  6. locked as resolved and limited conversation to collaborators on May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsUpdates to documentation, readme, docstrings, typos

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions