|
| 1 | +[<img src="https://beeware.org/project/briefcase/briefcase.png" width="72" alt="logo" />](https://beeware.org/briefcase) |
| 2 | + |
| 3 | +# Briefcase |
| 4 | + |
| 5 | +[](https://pypi.python.org/pypi/briefcase) |
| 6 | +[](https://pypi.python.org/pypi/briefcase) |
| 7 | +[](https://pypi.python.org/pypi/briefcase) |
| 8 | +[](https://github.com/beeware/briefcase/blob/main/LICENSE) |
| 9 | +[](https://github.com/beeware/briefcase/actions) |
| 10 | +[](https://beeware.org/bee/chat/) |
| 11 | + |
| 12 | +Briefcase is a tool for converting a Python project into a standalone |
| 13 | +native application. You can package projects for: |
| 14 | + |
| 15 | +- Mac |
| 16 | +- Windows |
| 17 | +- Linux |
| 18 | +- iPhone/iPad |
| 19 | +- Android |
| 20 | +- Web |
| 21 | + |
| 22 | +Support for AppleTV, watchOS, and wearOS deployments is planned. |
| 23 | + |
| 24 | +## Getting started |
| 25 | + |
| 26 | +To install Briefcase, run: |
| 27 | + |
| 28 | + $ python -m pip install briefcase |
| 29 | + |
| 30 | +If you would like a full introduction to using Briefcase, try the |
| 31 | +[BeeWare tutorial](https://docs.beeware.org). This tutorial walks you |
| 32 | +through the process of creating and packaging a new application with |
| 33 | +Briefcase. |
| 34 | + |
| 35 | +## Financial support |
| 36 | + |
| 37 | +The BeeWare project would not be possible without the generous support |
| 38 | +of our financial members: |
| 39 | + |
| 40 | +[](https://anaconda.com/) |
| 41 | + |
| 42 | +Anaconda Inc. - Advancing AI through open source. |
| 43 | + |
| 44 | +Plus individual contributions from [users like |
| 45 | +you](https://beeware.org/community/members/). If you find Briefcase, or |
| 46 | +other BeeWare tools useful, please consider becoming a financial member. |
| 47 | + |
| 48 | +## Documentation |
| 49 | + |
| 50 | +Documentation for Briefcase can be found on [Read The |
| 51 | +Docs](https://briefcase.readthedocs.io). |
| 52 | + |
| 53 | +## Community |
| 54 | + |
| 55 | +Briefcase is part of the [BeeWare suite](https://beeware.org). You can |
| 56 | +talk to the community through: |
| 57 | + |
| 58 | +- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware) |
| 59 | +- [Discord](https://beeware.org/bee/chat/) |
| 60 | +- The Briefcase [GitHub Discussions |
| 61 | + forum](https://github.com/beeware/briefcase/discussions) |
| 62 | + |
| 63 | +We foster a welcoming and respectful community as described in our |
| 64 | +[BeeWare Community Code of |
| 65 | +Conduct](https://beeware.org/community/behavior/). |
| 66 | + |
| 67 | +## Contributing |
| 68 | + |
| 69 | +If you experience problems with Briefcase, [log them on |
| 70 | +GitHub](https://github.com/beeware/briefcase/issues). |
| 71 | + |
| 72 | +If you'd like to contribute to Briefcase development, our [contribution |
| 73 | +guide](https://briefcase.readthedocs.io/en/latest/how-to/contribute/index.html) |
| 74 | +details how to set up a development environment, and other requirements |
| 75 | +we have as part of our contribution process. |
0 commit comments