4.3 What's New (#1120)

* fix docs for python 3.13 * 4.3 what's new * remove python 3.13 * Change Django 5.0 to 5.1 on Docker builds. Add Python 3.13 to build and test matrix. * remove python 3.13 from build bugfix for scaffold command * lint * fix tests * Revert to os.walk in scaffold_commands (Path.walk only supported in Python 3.12+) * Fix mock os.walk in scaffold command tests to return strings for dir path. * Fix scaffold command Path issue --------- Co-authored-by: Nathan Swain <[email protected]>
tethysplatform · Nov 29, 2024 · efd1cd6 · efd1cd6
1 parent 4cd3f1f
commit efd1cd6
Show file tree

Hide file tree

Showing 9 changed files with 188 additions and 142 deletions.
diff --git a/.github/workflows/tethys-release.yml b/.github/workflows/tethys-release.yml
@@ -20,7 +20,7 @@ jobs:
       matrix:
         platform: [ubuntu-latest]
         python-version: ["3.10", "3.11", "3.12"]
-        django-version: ["3.2", "4.2", "5.0"]
+        django-version: ["3.2", "4.2", "5.1"]
     steps:
       # Checkout the source
       - name: Checkout Source

diff --git a/.github/workflows/tethys.yml b/.github/workflows/tethys.yml
@@ -57,7 +57,7 @@ jobs:
       matrix:
         platform: [ubuntu-latest, macos-latest]
         python-version: ["3.10", "3.11", "3.12"]
-        django-version: ["3.2", "4.2", "5.0"]
+        django-version: ["3.2", "4.2", "5.1"]
     steps:
       # Checkout the source
       - name: Checkout Source
@@ -100,7 +100,7 @@ jobs:
       matrix:
         platform: [ubuntu-latest]
         python-version: ["3.10", "3.11", "3.12"]
-        django-version: ["3.2", "4.2", "5.0"]
+        django-version: ["3.2", "4.2", "5.1"]
     steps:
       # Checkout the source
       - name: Checkout Source
@@ -140,7 +140,7 @@ jobs:
       matrix:
         platform: [ubuntu-latest]
         python-version: ["3.10", "3.11", "3.12"]
-        django-version: ["3.2", "4.2", "5.0"]
+        django-version: ["3.2", "4.2", "5.1"]
     services:
       tethys-postgis:
         image: postgis/postgis:14-3.3

diff --git a/CITATION.cff b/CITATION.cff
@@ -1,8 +1,8 @@
 cff-version: 1.2.0
 message: "If you use this software, please cite it as below."
 title: "Tethys Platform"
-version: 4.2
-date-released: 2023-11-10
+version: 4.3
+date-released: 2024-11-29
 url: "https://github.com/tethysplatform/tethys"
 authors:
 - family-names: "Swain"

diff --git a/docs/conf.py b/docs/conf.py
@@ -106,7 +106,7 @@ def __getattr__(cls, name):
 # patcher.start()
 
 # Fixes django settings module problem
-sys.path.insert(0, Path("..").absolute().resolve())
+sys.path.insert(0, str(Path("..").absolute().resolve()))
 
 installed_apps = [
     "django.contrib.admin",

diff --git a/docs/tethys_portal/configuration.rst b/docs/tethys_portal/configuration.rst
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -4,95 +4,50 @@
 What's New
 **********
 
-**Last Updated:** November 2023
+**Last Updated:** November 2024
 
 Refer to this article for information about each new release of Tethys Platform.
 
 Release |version|
 ==================
 
-Python 3.12
------------
+Major Features
+--------------
 
-* Verified Tethys Platform works using Python 3.12
+Django 4/5 Support
+..................
 
-Conda Forge Package
--------------------
-
-* Tethys Platform is now fully packaged on conda-forge!
+* Tethys Platform 4.3 is compatible with Django versions 3.2 - 5.x. It is now recommended to explicitly specify the version of Django that you want when you create your tethys environment.
 
 See: :ref:`development_installation`
 
-Optional Dependencies and Micro Tethys
---------------------------------------
-
-* Made many of the dependencies of ``tethys-platform`` optional and released new ``micro-tethys-platform`` conda package on the ``tethysplatform`` channel with minimal dependencies
-* Updated docs to reflect what features are now optional and what dependencies are needed to support those features
-
-.. note::
-
-    The ``tethys-platform`` conda package for version 4.2 will still install all of the optional dependencies for backwards compatibility. Starting with Tethys version 5.0 the ``tethys-platform`` package will only have required dependencies. The ``micro-tethys-platform`` package, available on the ``tethysplatform`` channel, will install only the required dependencies allowing for a smaller Tethys environment.
-
-See: :ref:`optional_features`, :ref:`development_installation`
-
-Map Layout
-----------
-
-* Add labeling support for geojson features in MapLayout and MapView Gizmo.
-
-See: `label_options` in :ref:`map_layout`
+New Logo
+........
 
-Admin Pages
------------
+* The new logo design that is on the `Tethys Platform <https://www.tethysplatform.org/>`_ website is now in the default configuration of the Tethys Portal.
 
-* Added ability to have an icon on proxy app cards in the apps library to distinguish from native apps
+Single App Mode
+...............
 
-See: :ref:`portal_admin_proxy_apps`
+* Tethys can now be used to deploy just a single app by setting the new `MULTIPLE_APP_MODE` setting to `False`.
 
-Settings
---------
+See: :ref:`tethys_portal_config_settings`
 
-* Added new ``PREFIX_URL`` to enable modifying all portal URLs with a prefix
-* Added new settings ``ADDITIONAL_URLPATTERNS`` and ``ADDITIONAL_TEMPLATE_DIRS`` to allow more flexibility for supporting Django plugins
-* Replaced deprecated setting ``AXES_ONLY_USER_FAILURES`` with recommended setting ``AXES_LOCKOUT_PARAMETERS``
+Paths API
+.........
 
-See: :ref:`tethys_configuration`
+* The new Paths API replaces the Workspaces API (which will still be supported until version 5.0) and provides access to the new Media directories and the App Resources directory. It also makes better use of the Python `pathlib` library.
 
-OAuth2 Provider
----------------
+See: :ref:`tethys_paths_api`
 
-* Added support for the Django OAuth Toolkit plugin to allow a Tethys portal to be an OAuth provider.
+Async Support for the Jobs Table Gizmo
+......................................
 
-See: :ref:`optional_features`
-
-Tethys CLI
-----------
-
-* Added a ``--urls`` option to the ``tethys list`` command to list the ``UrlMaps`` for apps.
-
-See: :ref:`tethys_list_cmd`
-
-Bokeh
------
-
-* Added support for Bokeh version 3
-
-Jobs Table Gizmo
-----------------
-
-* Added a ``cached_status`` property to Tethys Jobs and optimized how the ``JobsTable`` gizmo loads statuses
-* Added ability to sort jobs in the ``JobsTable`` gizmo and specify sorting key
+* Jobs Table actions callbacks are now asynchronous enabling them to run without blocking the webserver. Custom actions can also be `async`.
 
 See: :ref:`jobs-table`
 
-Bug Fixes
----------
-
-* Fixed issue with the TethysJob update-status callback endpoint not updating job status
-* Fixed issue with assigning Custom JSON setting error when installing from file
-* Fixed `Issue 985  Remove References to UrlMaps in Gizmo Docs <https://github.com/tethysplatform/tethys/issues/985>`_
-* Fixed `Issue 881 The OneLoginOIDC Oauth backend is not compatible with the latest version of social-auth-core <https://github.com/tethysplatform/tethys/issues/881>`_
-* Fixed `Issue 976 Invalid Links for Map View Controls <https://github.com/tethysplatform/tethys/issues/976>`_
+For a full list of changes in version 4.3 refer to `<https://github.com/tethysplatform/tethys/releases/tag/4.3.0>`_
 
 Prior Release Notes
 ===================

diff --git a/docs/whats_new/prior_releases.rst b/docs/whats_new/prior_releases.rst
@@ -6,6 +6,94 @@ Prior Release Notes
 
 Information about prior releases is shown here.
 
+
+Release 4.2
+===========
+
+Python 3.12
+-----------
+
+* Verified Tethys Platform works using Python 3.12
+
+Conda Forge Package
+-------------------
+
+* Tethys Platform is now fully packaged on conda-forge!
+
+See: :ref:`development_installation`
+
+Optional Dependencies and Micro Tethys
+--------------------------------------
+
+* Made many of the dependencies of ``tethys-platform`` optional and released new ``micro-tethys-platform`` conda package on the ``tethysplatform`` channel with minimal dependencies
+* Updated docs to reflect what features are now optional and what dependencies are needed to support those features
+
+.. note::
+
+    The ``tethys-platform`` conda package for version 4.2 will still install all of the optional dependencies for backwards compatibility. Starting with Tethys version 5.0 the ``tethys-platform`` package will only have required dependencies. The ``micro-tethys-platform`` package, available on the ``tethysplatform`` channel, will install only the required dependencies allowing for a smaller Tethys environment.
+
+See: :ref:`optional_features`, :ref:`development_installation`
+
+Map Layout
+----------
+
+* Add labeling support for geojson features in MapLayout and MapView Gizmo.
+
+See: `label_options` in :ref:`map_layout`
+
+Admin Pages
+-----------
+
+* Added ability to have an icon on proxy app cards in the apps library to distinguish from native apps
+
+See: :ref:`portal_admin_proxy_apps`
+
+Settings
+--------
+
+* Added new ``PREFIX_URL`` to enable modifying all portal URLs with a prefix
+* Added new settings ``ADDITIONAL_URLPATTERNS`` and ``ADDITIONAL_TEMPLATE_DIRS`` to allow more flexibility for supporting Django plugins
+* Replaced deprecated setting ``AXES_ONLY_USER_FAILURES`` with recommended setting ``AXES_LOCKOUT_PARAMETERS``
+
+See: :ref:`tethys_configuration`
+
+OAuth2 Provider
+---------------
+
+* Added support for the Django OAuth Toolkit plugin to allow a Tethys portal to be an OAuth provider.
+
+See: :ref:`optional_features`
+
+Tethys CLI
+----------
+
+* Added a ``--urls`` option to the ``tethys list`` command to list the ``UrlMaps`` for apps.
+
+See: :ref:`tethys_list_cmd`
+
+Bokeh
+-----
+
+* Added support for Bokeh version 3
+
+Jobs Table Gizmo
+----------------
+
+* Added a ``cached_status`` property to Tethys Jobs and optimized how the ``JobsTable`` gizmo loads statuses
+* Added ability to sort jobs in the ``JobsTable`` gizmo and specify sorting key
+
+See: :ref:`jobs-table`
+
+Bug Fixes
+---------
+
+* Fixed issue with the TethysJob update-status callback endpoint not updating job status
+* Fixed issue with assigning Custom JSON setting error when installing from file
+* Fixed `Issue 985  Remove References to UrlMaps in Gizmo Docs <https://github.com/tethysplatform/tethys/issues/985>`_
+* Fixed `Issue 881 The OneLoginOIDC Oauth backend is not compatible with the latest version of social-auth-core <https://github.com/tethysplatform/tethys/issues/881>`_
+* Fixed `Issue 976 Invalid Links for Map View Controls <https://github.com/tethysplatform/tethys/issues/976>`_
+
+
 Release 4.1
 ===========