/toga

A Python native, OS native GUI toolkit.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

http://pybee.org/project/projects/libraries/toga/toga.png

Toga

https://beekeeper.herokuapp.com/projects/pybee/batavia/shield

A Python native, OS native GUI toolkit.

Prerequisites

Minimum requirements

  • Toga requires Python 3. Python 2 is not supported.
  • If you're on macOS, you need to be on 10.7 (Lion) or newer.
  • If you're on Linux, you need to have GTK+ 3.10 or later. This is the version that ships starting with Ubuntu 14.04 and Fedora 20. You also need to install the Python 3 bindings to GTK+.
  • We're working on Windows support, but not all features and widgets are supported. At a minimum, you'll need Python 3 and .NET Framework 4. This has been tested on Windows 10, but should work on 7 and 8. Pull requests, help and corrections are most welcome.

Optional extras for Linux

In Linux, extra packages are needed if you want to: 1. Use the WebView widget 2. Use Toga inside a Virtual Environment

  • Ubuntu / Debian sudo apt-get install python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-webkit2-4.0 libgirepository1.0-dev Note: for Ubuntu 14.04 install gir1.2-webkit-3.0 instead of gir1.2-webkit-4.0
  • Fedora sudo dnf install pygobject3 python3-gobject pywebkitgtk python3-cairo-devel cairo-gobject-devel gobject-introspection-devel or sudo yum install pygobject3 python3-gobject pywebkitgtk python3-cairo-devel cairo-gobject-devel gobject-introspection-devel
  • Arch Linux sudo pacman -S python-gobject webkit2gtk gobject-introspection

Other distros should be similar, but feel free to send a pull request with updated dependencies if needed.

If you are going to use Toga inside a Virtual Environment, you need to install pycairo and pygobject (in that order) in the virtualenv first:

$ pip install pycairo
$ pip install pygobject

If these requirements aren't met, Toga either won't work at all, or won't have full functionality.

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.

Community

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

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.