openstacksdk/releasenotes/notes/replace-appdirs-with-platformdirs-d3f5bcbe726b7829.yaml
Jeremy Stanley b34de32a54 Replace appdirs usage with platformdirs
The appdirs library has been abandoned for several years now, and a
fork named platformdirs is the recommended alternative. It's almost
a drop-in replacement, except the module and convenience class name
have changed. Adjust the internal variable name we're using for the
expansion to match as well, for all those consistent hobgoblins.

Add it with a >=3 lower bound because that introduces a breaking
change of the default configuration location for macOS users.
Include a release note about that too.

Depends-On: https://review.opendev.org/886642
Change-Id: I4c2b60ca0da29da1f605b4c0b5e77f8e1071a19c
2023-10-06 13:42:49 +00:00

9 lines
356 B
YAML

---
upgrade:
- |
The ``appdirs`` dependency is replaced by a requirement for
``platformdirs`` 3.0.0 or later. Users on macOS may need to move
configuration files to ``*/Library/Application Support``. See its release
notes for further details:
https://platformdirs.readthedocs.io/en/latest/changelog.html#platformdirs-3-0-0-2023-02-06