.. |logo| image:: https://beeware.org/project/projects/libraries/toga/toga.png :width: 72px :target: https://beeware.org/toga

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga.svg :target: https://pypi.python.org/pypi/toga :alt: Python Versions

.. |version| image:: https://img.shields.io/pypi/v/toga.svg :target: https://pypi.python.org/pypi/toga :alt: Project version

.. |maturity| image:: https://img.shields.io/pypi/status/toga.svg :target: https://pypi.python.org/pypi/toga :alt: Project status

.. |license| image:: https://img.shields.io/pypi/l/toga.svg :target: https://github.com/beeware/toga/blob/main/LICENSE :alt: BSD License

.. |ci| image:: https://github.com/beeware/toga/workflows/CI/badge.svg?branch=main :target: https://github.com/beeware/toga/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|

Toga

|pyversions| |version| |maturity| |license| |ci| |social|

A Python native, OS native GUI toolkit.

Minimum requirements

• Toga requires Python 3.8 or higher. Python 2 is not supported.

• If you're on macOS, you need to be on 11 (Big Sur) or newer.

• If you're on Windows, you'll need Windows 10 or newer. If you are using Windows 10 and want to use a WebView to display web content, you will also need to install the Edge WebView2 Evergreen Runtime. <https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section>__ Windows 11 has this runtime installed by default.

• If you're on Linux (or another Unix-based operating system), you need to have GTK+ 3.10 or newer. This is the version that ships starting with Ubuntu 14.04 and Fedora 20. You also need to install the system packages listed in Tutorial 0 <docs/tutorial/tutorial-0.rst>__.

Quickstart

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

Documentation for Toga can be found on Read The Docs_.

.. _Read The Docs: https://toga.readthedocs.io

Community

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_.

.. _BeeWare suite: https://beeware.org .. _@[email protected] on Mastodon: https://fosstodon.org/@beeware .. _Discord: https://beeware.org/bee/chat/ .. _Github Discussions forum: https://github.com/beeware/toga/discussions .. _BeeWare Community Code of Conduct: https://beeware.org/community/behavior/

Contributing

If you'd like to contribute to Toga development, our guide for first time contributors_ will help you get started.

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_.

.. _guide for first time contributors: https://toga.readthedocs.io/en/latest/how-to/contribute-code.html .. _log them on Github: https://github.com/beeware/toga/issues .. _fork the code: https://github.com/beeware/toga .. _submit a pull request: https://github.com/beeware/toga/pulls