This repository is the code for the BeeWare tutorial, saved as a project.
For the full tutorial experience, visit https://tutorial.beeware.org/ and follow the instructions there. However, if you're looking for a quick sampler of development using BeeWare, you can do the following:
You will need a supported Python3 interpreter. In addition, you will need the following platform-specific tools:
- macOS: Ensure you have installed Xcode, and have accepted the Xcode license. If you're unsure if you've accespted the Xcode license, run
sudo xcodebuild -license. - Windows: Ensure that you are not using Python 3.14+
- Linux: Install system dependencies for your distribution.
Once you've installed the pre-requisites:
-
Fork this repository into your own GitHub account by clicking the "Fork" button at the top of this page.
-
Check out your fork onto your own machine. Run
git clone https://github.com/brutus/helloworld(replacingbrutuswith your own Github username). -
Change into the helloworld directory:
cd helloworld -
Create a virtual environment:
python3 -m venv venv -
Activate the new virtual environment:
source venv/bin/activate -
Install Briefcase:
python -m pip install briefcase -
Run the project in developer mode:
briefcase dev -
Run the project in developer mode:
briefcase run -
Package the project into an installer:
briefcase package --adhoc
You've now got a fully functioning BeeWare app, packaged for distribution.
You can now modify the code in the app. Try some of the following tasks:
- Alter the title of the dialog
- Alter the text of the dialog to display a different greeting for some people (e.g., say "Hail, Brutus!" if the user's name is Brutus)
- Add a second button that displays a second dialog
After making each of your changes, run briefcase dev to test the changes in developer mode. Once you've got some changes that you're happy with, run briefcase run -u to update and run the updated version of the app.
You can talk to the BeeWare community through:
We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct.
If you experience problems with the BeeWare Tutorial, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request.