Replace appdirs with platformdirs #96
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Replace the
appdirs
dependency withplatformdirs
, an actively-maintained fork.Also, declare
platformdirs
as a dependency inpyproject.toml
.Details
Today I used
pystow
for the first time, and encountered aModuleNotFoundError
after setting the environment variablePYSTOW_USE_APPDIRS
totrue
:I hadn't noticed the warning in
docs/source/installation.rst
about needing to manually installappdirs
, as I had looked only at the top-level README, which didn't contain a similar warning. The desire to avoid manual installation ofappdirs
motivated me to submit a PR to declare it as a dependency inpyproject.toml
.However, given that
appdirs
is deprecated andplatformsdirs
is a suggested replacement, I figured I should take this opportunity to replaceappdirs
withplatformdirs
.Now, the user may set the environment variable
PYSTOW_USE_PLATFORMDIRS
(orPYSTOW_USE_APPDIRS
for backwards compatibility) to opt-in to the platform-specific user data directory.