Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document how to create a standalone application #2757

Open
davidism opened this issue Jul 31, 2024 · 3 comments
Open

document how to create a standalone application #2757

davidism opened this issue Jul 31, 2024 · 3 comments
Labels

Comments

@davidism
Copy link
Member

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.

@davidism davidism added the docs label Jul 31, 2024
@john0isaac
Copy link

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.

@davidism
Copy link
Member Author

davidism commented Aug 13, 2024

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.

@ofek
Copy link
Contributor

ofek commented Sep 29, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants