Merge pull request #133 from lsst/tickets/DM-36034

DM-36034: v24.0.0 release notes

.github/workflows/build.yaml

@@ -43,7 +43,7 @@ jobs:
       # We have two cores so we can speed up the testing with xdist
       - name: Install pytest packages
         shell: bash -l {0}
-        run: conda install -y -q pytest pytest-flake8 pytest-xdist pytest-openfiles pytest-cov
+        run: conda install -y -q pytest pytest-flake8 pytest-xdist pytest-openfiles pytest-cov "flake8<5"
 
       - name: Install numexpr for tests
         shell: bash -l {0}

README.rst

@@ -1,8 +1,15 @@
-=====
-utils
-=====
+==========
+lsst-utils
+==========
 
-Common code, floating-point utilities, test helpers, and angle stringification.
+.. image:: https://img.shields.io/pypi/v/lsst-utils.svg
+    :target: https://pypi.org/project/lsst-utils/
+
+.. image:: https://codecov.io/gh/lsst/utils/branch/master/graph/badge.svg?token=TUaqTDjdIZ  :target: https://codecov.io/gh/lsst/utils
+
+Utility functions from Rubin Observatory Data Management for the `Legacy Survey of Space and Time (LSST). <https://www.lsst.org>`_.
+
+PyPI: `lsst-utils <https://pypi.org/project/lsst-utils/>`_
 
 License
 -------

doc/lsst.utils/CHANGES.rst

@@ -1,12 +1,63 @@
-lsst.utils v22.0 (2021-07-09)
+lsst-utils v24.0.0 (2022-08-26)
+===============================
+
+New Features
+------------
+
+- Add option to ignore NaNs in ``lsst.utils.tests.assertFloatsAlmostEqual``. (`DM-29370 <https://jira.lsstcorp.org/browse/DM-29370>`_)
+- Add test decorators to operate on cartesian product. (`DM-31141 <https://jira.lsstcorp.org/browse/DM-31141>`_)
+- * Several new packages added from ``pipe_base`` and ``daf_butler``:
+
+    * ``lsst.utils.timer``
+    * ``lsst.utils.classes``
+    * ``lsst.utils.introspection``
+    * ``lsst.utils.iteration``
+    * ``lsst.utils.logging``
+  * Added ``lsst.utils.doImportType`` to import a python type from a string and guarantee it is not a module.
+  * ``lsst.utils.get_caller_name`` is now deprecated in its current location and has been relocated to ``lsst.utils.introspection``. (`DM-31722 <https://jira.lsstcorp.org/browse/DM-31722>`_)
+- Add `lsst.logging.set_trace_at` to control ``TRACE``-level loggers. (`DM-32142 <https://jira.lsstcorp.org/browse/DM-32142>`_)
+- Builds using ``setuptools`` now calculate versions from the Git repository, including the use of alpha releases for those associated with weekly tags. (`DM-32408 <https://jira.lsstcorp.org/browse/DM-32408>`_)
+- Context manager ``lsst.utils.timer.time_this`` can now include memory usage in its report. (`DM-33331 <https://jira.lsstcorp.org/browse/DM-33331>`_)
+- A new package `lsst.utils.packages` has been added to allow system package versions to be obtained.
+  This code has been relocated from ``lsst.base``. (`DM-33403 <https://jira.lsstcorp.org/browse/DM-33403>`_)
+- Add ``lsst.utils.threads`` for control of threads.
+  Use `lsst.utils.threads.disable_implicit_threading()` to disable implicit threading.
+  This function should be used in place of ``lsst.base.disableImplicitThreading()`` in all new code.
+  This package now depends on the `threadpoolctl` package. (`DM-33622 <https://jira.lsstcorp.org/browse/DM-33622>`_)
+- Added a new class `lsst.utils.logging.PeriodicLogger` to allow a user to issue log messages after some time interval has elapsed. (`DM-33919 <https://jira.lsstcorp.org/browse/DM-33919>`_)
+- Added ``lsst.utils.logging.getTraceLogger`` to simplify the creation of a trace logger that uses a ``TRACEn`` prefix for the logger name. (`DM-34208 <https://jira.lsstcorp.org/browse/DM-34208>`_)
+
+
+API Changes
+-----------
+
+- The values for max resident set size stored in metadata are now consistently reported as bytes.
+  Previously the units were platform specific (kibibytes on Liux and bytes on macOS). (`DM-20970 <https://jira.lsstcorp.org/browse/DM-20970>`_)
+- ``deprecate_pybind11`` now requires a ``version`` parameter.
+  This matches the upstream requirement from ``deprecated.deprecated`` (`DM-29701 <https://jira.lsstcorp.org/browse/DM-29701>`_)
+- Add parameter to `~lsst.utils.packages.getEnvironmentPackages` to return all EUPS packages rather than just those that are locally setup. (`DM-33934 <https://jira.lsstcorp.org/browse/DM-33934>`_)
+
+
+Performance Enhancement
+-----------------------
+
+- Fixed an optimization when using `lsst.utils.TemplateMeta` classes with `isinstance` or `issubclass`. (`DM-32661 <https://jira.lsstcorp.org/browse/DM-32661>`_)
+
+
+lsst-utils v23.0.0 (2021-09-27)
+===============================
+
+- Moved all C++ code out of this package and into ``cpputils`` package and changed license to BSD 3-clause. (`DM-31721 <https://jira.lsstcorp.org/browse/DM-31721>`_)
+
+lsst-utils v22.0 (2021-07-09)
 =============================
 
 Bug fix
 -------
 
 * Error reporting in `~lsst.utils.doImport` has been improved. [DM-27638]
 
-lsst.utils v21.0 (2020-12-08)
+lsst-utils v21.0 (2020-12-08)
 =============================
 
 New Features

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
     package_dir = "python"
     filename = "doc/lsst.utils/CHANGES.rst"
     directory = "doc/changes"
-    title_format = "lsst_utils {version} {project_date}"
+    title_format = "lsst-utils {version} ({project_date})"
     issue_format = "`{issue} <https://jira.lsstcorp.org/browse/{issue}>`_"