BeeWare Documentation

Release 0.1.1

Russell Keith-Magee

May 07, 2019

 Contents

1 Table of contents 3
1.1 Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 How-to guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Community 5
2.1 Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 How-to Guides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.4 Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

i
ii
 BeeWare Documentation, Release 0.1.1

BeeWare is a Python native, OS native, cross platform GUI toolkit. Toga consists of a library of base components with
a shared interface to simplify platform-agnostic GUI development.
BeeWare is a suite of tools and libraries, each of which works together to help you write cross platform native GUI
applications:
• Toga, a cross platform widget toolkit
• Briefcase, an application packaging tool
• Rubicon, a library for accessing Objective C libraries on iOS and macOS
• VOC, a compiler for converting Python into Java bytecode
• Batavia, an interpreter for running Python in a web browser.
• and more.
You can use each of the tools in isolation, or you can use all of them as a suite. There is a beeware helper tool to assit
using all the tools as a suite.
The BeeWare suite is available on Mac OS, Windows, Linux (GTK); mobile platforms such as Android and iOS; and
for the Web.

Contents 1
BeeWare Documentation, Release 0.1.1

2 Contents
 CHAPTER 1

Table of contents

1.1 Tutorial

Get started with a hands-on introduction to BeeWare for beginners

1.2 How-to guides

Guides and recipes for common problems and tasks

1.3 Background

Explanation and discussion of key topics and concepts

1.4 Reference

Technical reference - commands, modules, classes, methods

3
BeeWare Documentation, Release 0.1.1

4 Chapter 1. Table of contents

 CHAPTER 2

Community

You can talk to the community through:

• @pybeeware on Twitter
• pybee/general on Gitter

2.1 Tutorials

2.1.1 Tutorial 0 - Your first app

2.1.2 Tutorial 0 - your first BeeWare app

In Tutorial 0 - Your first app, you will discover how to create a basic BeeWare app for a desktop operating system
(macOS, Windows or Linux).

2.2 How-to Guides

2.2.1 How to get started

Quickstart

The easiest way to demonstrate Create a new virtual environment. In that environment, install the Toga demo, and
then run it:

$ pip install toga-demo

$ toga-demo

This will pop up a GUI window showing the full range of widgets available to an application using Toga.
Have fun, and see the Reference to learn more about what’s going on.

5
BeeWare Documentation, Release 0.1.1

2.2.2 How to contribute to Toga

If you experience problems with Toga, log them on GitHub. If you want to contribute code, please fork the code and
submit a pull request.

2.3 Reference

2.4 Background

2.4.1 FAQ

2.4.2 Success stories

2.4.3 Release History

0.1.1

Bugfix release; v0.1 was incorrectly packaged.

0.1

Initial release;

2.4.4 BeeWare Roadmap

BeeWare is a new project - we have lots of things that we’d like to do. If you’d like to contribute, you can provide a
patch for one of these features.

6 Chapter 2. Community