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

DM-36034: v24.0.0 release notes

Author: timj

.github/workflows/build.yaml

@@ -58,7 +58,7 @@ jobs:
         shell: bash -l {0}
         run: |
           conda install -y -q \
-            flake8 \
+            "flake8<5" \
             pytest pytest-flake8 pytest-xdist pytest-openfiles pytest-cov
 
       - name: List installed packages

README.md

@@ -1,5 +1,9 @@
 # lsst.resources
 
+[![pypi](https://img.shields.io/pypi/v/lsst-resources.svg)](https://pypi.org/project/lsst-resources/)
+[![codecov](https://codecov.io/gh/lsst/resources/branch/main/graph/badge.svg?token=jGf63Xc1Ar)](https://codecov.io/gh/lsst/resources)
+
+
 This package provides a simple interface to local or remote files using URIs.
 
 ```
@@ -12,6 +16,8 @@ s3_uri = ResourcePath("s3://bucket/data/file.txt")
 contents = s3_uri.read()
 ```
 
-The package currently understands `file`, `s3`, `http[s]`, and `resource` (Python package resource) URI schemes as well as a scheme-less URI (relative local file path).
+The package currently understands `file`, `s3`, `gs`, `http[s]`, and `resource` (Python package resource) URI schemes as well as a scheme-less URI (relative local file path).
+
+The package provides the main file abstraction layer in the [Rubin Observatory Data Butler](https://github.com/lsst/daf_butler) datastore.
 
-The is package provides the main file abstraction layer in the [Rubin Observatory Data Butler](https://github.com/lsst/daf_butler) datastore.
+PyPI: [lsst-resources](https://pypi.org/project/lsst-resources/)

doc/changes/DM-27355.feature.rst

@@ -13,7 +13,6 @@ The ``<TYPE>`` should be one of:
 * ``perf``: A performance enhancement.
 * ``doc``: A documentation improvement.
 * ``removal``: An API removal or deprecation.
-* ``other``: Other Changes and Additions of interest to general users.
 * ``misc``: Changes that are of minor interest.
 
 An example file name would therefore look like ``DM-30291.misc.rst``.

doc/changes/DM-31723.feature.rst

@@ -1,4 +1,32 @@
-resources Changes
-=================
+Resources v24.0.0 2022-08-26
+============================
 
-* The ButlerURI code has been extracted from the ``daf_butler`` package and made into a standalone package. It is now known as `lsst.resources.ResourcePath` (DM-31723)
+New Features
+------------
+
+- This package is now available on `PyPI as lsst-resources <https://pypi.org/project/lsst-resources/>`_.
+- The ``lsst.daf.butler.ButlerURI`` code has been extracted from the ``daf_butler`` package and made into a standalone package. It is now known as `lsst.resources.ResourcePath` and distributed in the ``lsst-resources`` package.
+- Add support for Google Cloud Storage access using the ``gs`` URI scheme. (`DM-27355 <https://jira.lsstcorp.org/browse/DM-27355>`_)
+- 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>`_)
+- Add an `open` method that returns a file-like buffer wrapped by a context manager. (`DM-32842 <https://jira.lsstcorp.org/browse/DM-32842>`_)
+- Major cleanup of the WebDAV interface:
+
+  * Improve client timeout and retries.
+  * Improve management of persistent connections to avoid exhausting server
+    resources when there are thousands of simultaneous clients.
+  * Rename environment variables previously named ``LSST_BUTLER_*`` by:
+
+      * ``LSST_HTTP_CACERT_BUNDLE``
+      * ``LSST_HTTP_AUTH_BEARER_TOKEN``
+      * ``LSST_HTTP_AUTH_CLIENT_CERT``
+      * ``LSST_HTTP_AUTH_CLIENT_KEY``
+      * ``LSST_HTTP_PUT_SEND_EXPECT_HEADER`` (`DM-33769 <https://jira.lsstcorp.org/browse/DM-33769>`_)
+
+
+Miscellaneous Changes of Minor Interest
+---------------------------------------
+
+- Reorganize test code to enhance code reuse and allow new schemes to make use of existing tests. (`DM-33394 <https://jira.lsstcorp.org/browse/DM-33394>`_)
+- Attempt to catch 429 Retry client error in S3 interface.
+  This code is not caught by ``botocore`` itself since it is not part of the AWS standard but Google can generate it. (`DM-33597 <https://jira.lsstcorp.org/browse/DM-33597>`_)
+- When walking the local file system symlinks to directories are now followed. (`DM-35446 <https://jira.lsstcorp.org/browse/DM-35446>`_)

doc/changes/DM-32408.feature.rst

@@ -22,6 +22,8 @@ Design and Development
 
 ``lsst.resources`` is developed at https://github.com/lsst/resources.
 
+It is available from PyPI as ``lsst-resources``: https://pypi.org/project/lsst-resources/
+
 .. _lsst.resources-pyapi:
 
 Python API reference

doc/changes/DM-32482.feature.rst

@@ -93,12 +93,12 @@ version = { attr = "lsst.resources.__version__" }
     [[tool.towncrier.type]]
         directory = "misc"
         name = "Miscellaneous Changes of Minor Interest"
-        showcontent = false
+        showcontent = true
 
     [[tool.towncrier.type]]
         directory = "removal"
         name = "An API Removal or Deprecation"
-        showcontent = false
+        showcontent = true
 
 [tool.black]
 line-length = 110