Update platformdirs

jwodder · Feb 9, 2023 · 2150201 · 2150201
1 parent 7c50d66
commit 2150201
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 7 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: check-added-large-files
       - id: check-json
@@ -10,17 +10,17 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.1.0
     hooks:
       - id: black
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 6.0.0
     hooks:
       - id: flake8
         additional_dependencies:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+v0.5.0 (in development)
+-----------------------
+- Update `platformdirs` dependency to v3.  This is a **breaking** change on
+  macOS, where the default configuration path changes from
+  `~/Library/Preferences/outgoing/outgoing.toml` back to `~/Library/Application
+  Support/outgoing/outgoing.toml`.
+
 v0.4.0 (2022-10-25)
 -------------------
 - Drop support for Python 3.6

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -3,6 +3,13 @@
 Changelog
 =========
 
+v0.5.0 (in development)
+-----------------------
+- Update ``platformdirs`` dependency to v3.  This is a **breaking** change on
+  macOS, where the default configuration path changes from
+  :file:`~/Library/Preferences/outgoing/outgoing.toml` back to
+  :file:`~/Library/Application Support/outgoing/outgoing.toml`.
+
 v0.4.0 (2022-10-25)
 -------------------
 - Drop support for Python 3.6

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -15,7 +15,7 @@ TOML, and its location depends on your OS:
 =======  ====================================================================
 Linux    :file:`~/.local/share/outgoing/outgoing.toml`
          or :file:`$XDG_DATA_HOME/outgoing/outgoing.toml`
-macOS    :file:`~/Library/Preferences/outgoing/outgoing.toml`
+macOS    :file:`~/Library/Application Support/outgoing/outgoing.toml`
 Windows  :file:`C:\\Users\\<username>\\AppData\\Local\\jwodder\\outgoing\\outgoing.toml`
 =======  ====================================================================
 
@@ -26,6 +26,12 @@ Windows  :file:`C:\\Users\\<username>\\AppData\\Local\\jwodder\\outgoing\\outgoi
     Support/outgoing/outgoing.toml` to
     :file:`~/Library/Preferences/outgoing/outgoing.toml`.
 
+.. versionchanged:: 0.5.0
+
+    Due to an upgrade to v3 of ``platformdirs``, the default configuration path
+    on macOS changed from :file:`~/Library/Preferences/outgoing/outgoing.toml`
+    back to :file:`~/Library/Application Support/outgoing/outgoing.toml`.
+
 To find the exact path on your system, after installing ``outgoing``, run::
 
     python3 -c "from outgoing import get_default_configpath; print(get_default_configpath())"

diff --git a/setup.cfg b/setup.cfg
@@ -53,7 +53,7 @@ install_requires =
     importlib-metadata >= 3.6; python_version < "3.10"
     keyring        >= 21.7
     morecontext    ~= 0.4
-    platformdirs   ~= 2.1
+    platformdirs   ~= 3.0
     pydantic       ~= 1.7
     python-dotenv  ~= 0.11
     tomli          >= 1.2, < 3.0; python_version < "3.11"

diff --git a/src/outgoing/__init__.py b/src/outgoing/__init__.py
@@ -13,7 +13,7 @@
 more information.
 """
 
-__version__ = "0.4.0"
+__version__ = "0.5.0.dev1"
 __author__ = "John Thorvald Wodder II"
 __author_email__ = "outgoing@varonathe.org"
 __license__ = "MIT"