toga Documentation

1. Project Overview & Quickstart (beeware/toga) Copy Chapter

Toga

A Python native, OS native GUI toolkit.

Minimum requirements Copy Chapter

Each backend has specific requirements and pre-requisites. See the platform documentation for details.

Quickstart Copy Chapter

To get a demonstration of the capabilities of Toga, run the following:

$ pip install toga-demo
$ toga-demo

This will pop up a GUI window with some sample widgets.

Documentation Copy Chapter

Documentation for Toga can be found on Read The Docs.

Financial support Copy Chapter

The BeeWare project would not be possible without the generous support of our financial members:

Anaconda Inc. - Advancing AI through open source.

Plus individual contributions from users like you. If you find Toga, or other BeeWare tools useful, please consider becoming a financial member.

Community Copy Chapter

Toga is part of the BeeWare suite. You can talk to the community through:

• @[email protected] on Mastodon
• Discord
• The Toga GitHub Discussions forum

We foster a welcoming and respectful community as described in our BeeWare Community Code of Conduct.

Contributing Copy Chapter

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.

2. Official Technical Reference & Guides (beeware/beeware.github.io) Copy Chapter

beeware.org

This is the homepage for the BeeWare project.

It is a MkDocs-based site. The site is hosted on GitHub Pages, with PR builds being provided by ReadTheDocs.

Getting started Copy Chapter

To view a local build of this website, create a virtual environment, and install the development requirements:

$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install --group dev

Then from the root directory of the checkout, run:

(venv) $ tox -e docs-live

This will start a web server that will automatically reload whenever you make a change to site content. This will only build the English version of the site; to build and test the full site, run:

(venv) $ tox -e docs-all,docs-serve

This will also start a web server; however the content will not automatically reload.

Financial support Copy Chapter

The BeeWare project would not be possible without the generous support of our financial members:

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.

Community Copy Chapter

You can talk to the community through:

• @[email protected] on Mastodon
• BeeWare Discord server: Discord
• Tickets on the website issue tracker

Code of Conduct Copy Section

The BeeWare community has a strict Code of Conduct. All users and developers are expected to adhere to this code.

If you have any concerns about this code of conduct, or you wish to report a violation of this code, please contact the project founder Russell Keith-Magee.

Contributing Copy Section

If you find problems with this website, log them on GitHub. If you want to contribute a modification you can fork this repository and submit a pull request.

Translations Copy Section

We manage translations using Weblate. Updates to translated content should be submitted through Weblate, not as PRs to this repository.

If you'd like to contribute to the translation effort, join the #translations channel on Discord and introduce yourself!