From 5c3b304315cf54837ee586359d8cdf0287c40f6f Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Thu, 8 May 2025 13:20:10 +0800 Subject: [PATCH 1/5] Correct version number reference. --- toga/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/toga/README.rst b/toga/README.rst index e1ee33ec43..b0ae88cfa0 100644 --- a/toga/README.rst +++ b/toga/README.rst @@ -15,7 +15,7 @@ Backends are also available for `Android `__, and `testing `__; however, these must be installed manually. -Toga requires **Python 3.8** or newer. It does not support Python 2. Some platforms have +Toga requires **Python 3.9** or newer. It does not support Python 2. Some platforms have additional prerequisites; see the `Toga platform guide `__ for details. From adb583b7429a89fb2c8c1d55229ab9680160f37e Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 12 May 2025 10:00:53 +0800 Subject: [PATCH 2/5] Add changenote. --- changes/3439.misc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/3439.misc.rst diff --git a/changes/3439.misc.rst b/changes/3439.misc.rst new file mode 100644 index 0000000000..9de1d2b70b --- /dev/null +++ b/changes/3439.misc.rst @@ -0,0 +1 @@ +The minimum Python version in the toga base package README was corrected. From fb4ad2d72981ec0d57c83a87e5ab637507c483eb Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 13 May 2025 08:45:56 -0400 Subject: [PATCH 3/5] Correct references to platform docs. --- changes/3439.misc.rst | 2 +- core/README.rst | 6 ++---- toga/README.rst | 5 ++--- 3 files changed, 5 insertions(+), 8 deletions(-) diff --git a/changes/3439.misc.rst b/changes/3439.misc.rst index 9de1d2b70b..0456d95aeb 100644 --- a/changes/3439.misc.rst +++ b/changes/3439.misc.rst @@ -1 +1 @@ -The minimum Python version in the toga base package README was corrected. +References to the minimum Python version in READMEs have been removed. diff --git a/core/README.rst b/core/README.rst index 9a2776203c..7959eca9e9 100644 --- a/core/README.rst +++ b/core/README.rst @@ -17,10 +17,8 @@ install a backend that implements the core Toga API for that platform: Minimum requirements -------------------- -Toga requires **Python 3.9** or newer. - -Each backend also has specific requirements and pre-requisites. See the `platform -documentation `__ for +Each backend has specific requirements and pre-requisites. See the `platform +documentation `__ for details. Quickstart diff --git a/toga/README.rst b/toga/README.rst index b0ae88cfa0..67d9dfcfd0 100644 --- a/toga/README.rst +++ b/toga/README.rst @@ -15,9 +15,8 @@ Backends are also available for `Android `__, and `testing `__; however, these must be installed manually. -Toga requires **Python 3.9** or newer. It does not support Python 2. Some platforms have -additional prerequisites; see the `Toga platform guide -`__ for details. +Some platforms have additional prerequisites; see the `Toga platform guide +`__ for details. For more details, see the `Toga project on Github`_. From c8f206962ffaa7911c4bb30811d76dbc12e01d59 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 13 May 2025 08:55:33 -0400 Subject: [PATCH 4/5] Add pyversion, license and maturity shields to individual projects. --- README.rst | 10 +++++----- android/README.rst | 14 ++++++++++++++ cocoa/README.rst | 14 ++++++++++++++ core/README.rst | 14 ++++++++++++++ gtk/README.rst | 14 ++++++++++++++ iOS/README.rst | 14 ++++++++++++++ textual/README.rst | 14 ++++++++++++++ toga/README.rst | 14 ++++++++++++++ travertino/README.rst | 26 ++++---------------------- web/README.rst | 14 ++++++++++++++ winforms/README.rst | 14 ++++++++++++++ 11 files changed, 135 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index e30c623bdc..66616c24ad 100644 --- a/README.rst +++ b/README.rst @@ -10,14 +10,14 @@ :target: https://pypi.python.org/pypi/toga :alt: Project version +.. |license| image:: https://img.shields.io/pypi/l/toga.svg + :target: https://github.com/beeware/toga/blob/main/LICENSE + :alt: BSD-3-Clause License + .. |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 @@ -31,7 +31,7 @@ Toga ==== -|pyversions| |version| |maturity| |license| |ci| |social| +|pyversions| |license| |version| |maturity| |ci| |social| A Python native, OS native GUI toolkit. diff --git a/android/README.rst b/android/README.rst index d6606fec7e..a6eeb681c6 100644 --- a/android/README.rst +++ b/android/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-android.svg + :target: https://pypi.python.org/pypi/toga-android + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-android.svg + :target: https://github.com/beeware/toga-android/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-android.svg + :target: https://pypi.python.org/pypi/toga-android + :alt: Project status + toga-android ============ +|pyversions| |license| |maturity| + An Android backend for the `Toga widget toolkit`_. This package isn't much use by itself; it needs to be combined with `the core Toga library`_, diff --git a/cocoa/README.rst b/cocoa/README.rst index 0408456cf7..c3645c3a51 100644 --- a/cocoa/README.rst +++ b/cocoa/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-android.svg + :target: https://pypi.python.org/pypi/toga-android + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-android.svg + :target: https://github.com/beeware/toga-android/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-android.svg + :target: https://pypi.python.org/pypi/toga-android + :alt: Project status + toga-cocoa ========== +|pyversions| |license| |maturity| + A Cocoa backend for the `Toga widget toolkit`_. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. diff --git a/core/README.rst b/core/README.rst index 7959eca9e9..a34648169d 100644 --- a/core/README.rst +++ b/core/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-core.svg + :target: https://pypi.python.org/pypi/toga-core + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-core.svg + :target: https://github.com/beeware/toga-core/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-core.svg + :target: https://pypi.python.org/pypi/toga-core + :alt: Project status + Toga ==== +|pyversions| |license| |maturity| + A Python native, OS native GUI toolkit. This package provides the core Toga API. In order to use Toga, you'll also need to diff --git a/gtk/README.rst b/gtk/README.rst index 8698faf903..4a7a55daae 100644 --- a/gtk/README.rst +++ b/gtk/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-gtk.svg + :target: https://pypi.python.org/pypi/toga-gtk + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-gtk.svg + :target: https://github.com/beeware/toga-gtk/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-gtk.svg + :target: https://pypi.python.org/pypi/toga-gtk + :alt: Project status + toga-gtk ======== +|pyversions| |license| |maturity| + A GTK backend for the `Toga widget toolkit`_. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. diff --git a/iOS/README.rst b/iOS/README.rst index 6651a7a6f2..cdac9464a4 100644 --- a/iOS/README.rst +++ b/iOS/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-ios.svg + :target: https://pypi.python.org/pypi/toga-ios + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-ios.svg + :target: https://github.com/beeware/toga-ios/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-ios.svg + :target: https://pypi.python.org/pypi/toga-ios + :alt: Project status + toga-iOS ======== +|pyversions| |license| |maturity| + An iOS backend for the `Toga widget toolkit`_. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. diff --git a/textual/README.rst b/textual/README.rst index b08be8ac73..1761887621 100644 --- a/textual/README.rst +++ b/textual/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-textual.svg + :target: https://pypi.python.org/pypi/toga-textual + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-textual.svg + :target: https://github.com/beeware/toga-textual/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-textual.svg + :target: https://pypi.python.org/pypi/toga-textual + :alt: Project status + toga-textual ============ +|pyversions| |license| |maturity| + A Textual backend for the `Toga widget toolkit`_. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. diff --git a/toga/README.rst b/toga/README.rst index 67d9dfcfd0..a136a81371 100644 --- a/toga/README.rst +++ b/toga/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga.svg + :target: https://pypi.python.org/pypi/toga + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga.svg + :target: https://github.com/beeware/toga/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga.svg + :target: https://pypi.python.org/pypi/toga + :alt: Project status + toga ==== +|pyversions| |license| |maturity| + A meta-package for installing the `Toga widget toolkit`_. This package installs the `toga-core `__ library, diff --git a/travertino/README.rst b/travertino/README.rst index 979f06ca15..6d64680da7 100644 --- a/travertino/README.rst +++ b/travertino/README.rst @@ -1,37 +1,19 @@ -.. |logo| image:: https://beeware.org/static/images/defaultlogo.png - :width: 72px - :target: https://beeware.org - .. |pyversions| image:: https://img.shields.io/pypi/pyversions/travertino.svg :target: https://pypi.python.org/pypi/travertino :alt: Python Versions -.. |version| image:: https://img.shields.io/pypi/v/travertino.svg - :target: https://pypi.python.org/pypi/travertino - :alt: Project version +.. |license| image:: https://img.shields.io/pypi/l/travertino.svg + :target: https://github.com/beeware/toga/blob/main/travertino/LICENSE + :alt: BSD-3-Clause License .. |maturity| image:: https://img.shields.io/pypi/status/travertino.svg :target: https://pypi.python.org/pypi/travertino :alt: Project status -.. |license| image:: https://img.shields.io/pypi/l/travertino.svg - :target: https://github.com/beeware/toga/blob/main/travertino/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| - Travertino ========== -|pyversions| |version| |maturity| |license| |ci| |social| +|pyversions| |license| |maturity| Travertino is a set of constants and utilities for describing user interfaces, including: diff --git a/web/README.rst b/web/README.rst index 8dbad92f3f..5e915932b3 100644 --- a/web/README.rst +++ b/web/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-web.svg + :target: https://pypi.python.org/pypi/toga-web + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-web.svg + :target: https://github.com/beeware/toga-web/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-web.svg + :target: https://pypi.python.org/pypi/toga-web + :alt: Project status + toga-web ======== +|pyversions| |license| |maturity| + A backend for the `Toga widget toolkit`_ on web platforms. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. diff --git a/winforms/README.rst b/winforms/README.rst index e03a19aa25..c7480b1ea1 100644 --- a/winforms/README.rst +++ b/winforms/README.rst @@ -1,6 +1,20 @@ +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/toga-winforms.svg + :target: https://pypi.python.org/pypi/toga-winforms + :alt: Python Versions + +.. |license| image:: https://img.shields.io/pypi/l/toga-winforms.svg + :target: https://github.com/beeware/toga-winforms/blob/main/LICENSE + :alt: BSD-3-Clause License + +.. |maturity| image:: https://img.shields.io/pypi/status/toga-winforms.svg + :target: https://pypi.python.org/pypi/toga-winforms + :alt: Project status + toga-winforms ============= +|pyversions| |license| |maturity| + A Microsoft .NET backend for the `Toga widget toolkit`_ utilizing the WinForms API. This package isn't much use by itself; it needs to be combined with `the core Toga library`_. From 32494334176a4e37b04a2a9ec664a6cc9f7b5af9 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 13 May 2025 08:57:31 -0400 Subject: [PATCH 5/5] Modified project README to be consistent with subprojects. --- README.rst | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 66616c24ad..4033d67713 100644 --- a/README.rst +++ b/README.rst @@ -38,20 +38,9 @@ A Python native, OS native GUI toolkit. Minimum requirements -------------------- -* Toga requires **Python 3.9 or higher**. - -* 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 - `__. - 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.24 and glib >= 2.64. These are available starting with Ubuntu 20.04 and - Fedora 32. You also need to install the system packages listed in `Linux platform - documentation `__. +Each backend has specific requirements and pre-requisites. See the `platform +documentation `__ for +details. Quickstart ----------