AppDirs

Warnings

• deprecated This project has been officially deprecated. It is recommended to use `platformdirs` (https://pypi.org/project/platformdirs/) which is an actively maintained fork with similar functionality.
  Fix: Migrate your application to use the `platformdirs` library. The API is largely compatible, making migration straightforward.
• gotcha AppDirs is 'slightly opinionated' on directory names. The exact paths generated can sometimes differ from strict system conventions or other tools' interpretations, potentially leading to unexpected locations. For instance, specific suffixes might be added to directory names.
  Fix: Always verify the generated paths on your target operating systems. If `appdirs`'s default naming is problematic, consider examining the `platformdirs` documentation for more flexible options or implementing custom logic.
• gotcha While version 1.4.4 is generally compatible with Python 3, earlier 1.x releases (e.g., 1.4.1) had specific issues with Python 3, particularly concerning Windows registry access (`winreg`) and string handling, which were addressed in subsequent minor releases. If working with older Python 3 environments or `appdirs` versions, verify generated paths carefully.
  Fix: Ensure you are using at least `appdirs==1.4.4` for Python 3 environments. For the best compatibility and ongoing support, migrate to `platformdirs`.

Install

• pip install appdirs Install latest version

Imports

• user_data_dir

  from appdirs import user_data_dir

  Commonly imported functions include `user_data_dir`, `user_config_dir`, `user_cache_dir`, `site_data_dir`, `site_config_dir`, and `user_log_dir`.

Quickstart

This quickstart demonstrates how to use `appdirs` to retrieve common application-specific directory paths for the current user and platform. It also shows how to create one of these directories if it doesn't already exist.

from appdirs import user_data_dir, user_cache_dir, user_log_dir
import os

appname = "MyApplication"
appauthor = "MyCompany"
appversion = "1.0.0"

# Get platform-specific directories
data_dir = user_data_dir(appname, appauthor, appversion=appversion)
cache_dir = user_cache_dir(appname, appauthor)
log_dir = user_log_dir(appname, appauthor)

print(f"Data directory: {data_dir}")
print(f"Cache directory: {cache_dir}")
print(f"Log directory: {log_dir}")

# Example: Ensure the data directory exists
os.makedirs(data_dir, exist_ok=True)
print(f"Ensured data directory exists: {os.path.exists(data_dir)}")