https://github.com/beeware/briefcase
Tools to support converting a Python project into a standalone native application.
https://github.com/beeware/briefcase
Last synced: 14 days ago
JSON representation
Tools to support converting a Python project into a standalone native application.
- Host: GitHub
- URL: https://github.com/beeware/briefcase
- Owner: beeware
- License: bsd-3-clause
- Created: 2015-07-28T15:20:03.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-05-03T01:51:13.000Z (23 days ago)
- Last Synced: 2025-05-03T02:56:31.523Z (22 days ago)
- Language: Python
- Homepage: https://briefcase.readthedocs.io/
- Size: 12 MB
- Stars: 2,887
- Watchers: 49
- Forks: 397
- Open Issues: 176
-
Metadata Files:
- Readme: README.rst
- Changelog: changes/.gitignore
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- best-of-python-dev - GitHub - 17% open · ⏱️ 30.05.2024): (Code Packaging)
README
.. |logo| image:: https://beeware.org/project/briefcase/briefcase.png
:width: 72px
:target: https://beeware.org/briefcase
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/briefcase.svg
:target: https://pypi.python.org/pypi/briefcase
:alt: Python Versions
.. |version| image:: https://img.shields.io/pypi/v/briefcase.svg
:target: https://pypi.python.org/pypi/briefcase
:alt: PyPI Version
.. |maturity| image:: https://img.shields.io/pypi/status/briefcase.svg
:target: https://pypi.python.org/pypi/briefcase
:alt: Maturity
.. |license| image:: https://img.shields.io/pypi/l/briefcase.svg
:target: https://github.com/beeware/briefcase/blob/main/LICENSE
:alt: BSD License
.. |ci| image:: https://github.com/beeware/briefcase/workflows/CI/badge.svg?branch=main
:target: https://github.com/beeware/briefcase/actions
:alt: Build Status
.. |social| image:: https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic
:target: https://beeware.org/bee/chat/
:alt: Discord server
|logo|
Briefcase
=========
|pyversions| |version| |maturity| |license| |ci| |social|
Briefcase is a tool for converting a Python project into a standalone native
application. You can package projects for:
* Mac
* Windows
* Linux
* iPhone/iPad
* Android
* Web
Support for AppleTV, watchOS, and wearOS deployments is planned.
Getting started
---------------
To install Briefcase, run::
$ python -m pip install briefcase
If you would like a full introduction to using Briefcase, try the `BeeWare tutorial
`__. This tutorial walks you through the process of creating
and packaging a new application with Briefcase.
Financial support
-----------------
The BeeWare project would not be possible without the generous support of our financial
members:
.. image:: https://beeware.org/community/members/anaconda/anaconda-large.png
:target: https://anaconda.com/
:alt: Anaconda logo
Anaconda Inc. - Advancing AI through open source.
Plus individual contributions from `users like you
`__. If you find Briefcase, or other BeeWare
tools useful, please consider becoming a financial member.
Documentation
-------------
Documentation for Briefcase can be found on `Read The Docs
`__.
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 `__
We foster a welcoming and respectful community as described in our `BeeWare Community
Code of Conduct `__.
Contributing
------------
If you experience problems with Toga, `log them on GitHub
`__.
If you'd like to contribute to Toga development, our `contribution guide
`__
details how to set up a development environment, and other requirements we have
as part of our contribution process.