platformdirs 4.7.1

A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`.

platformdirs

A Python package for determining platform-specific directories (e.g. user data, config, cache, logs). Handles the differences between macOS, Windows, Linux/Unix, and Android so you don't have to.

Quick start

from platformdirs import PlatformDirs

dirs = PlatformDirs("MyApp", "MyCompany")
dirs.user_data_dir  # e.g. ~/.local/share/MyApp on Linux
dirs.user_config_dir  # e.g. ~/.config/MyApp on Linux
dirs.user_cache_dir  # e.g. ~/.cache/MyApp on Linux
dirs.user_log_dir  # e.g. ~/.local/state/MyApp/log on Linux

Convenience functions are also available:

from platformdirs import user_data_dir, user_config_path

user_data_dir("MyApp", "MyCompany")  # returns str
user_config_path("MyApp", "MyCompany")  # returns pathlib.Path

Documentation

Full documentation is available at platformdirs.readthedocs.io, including:

• Usage guide -- parameters, examples, and patterns
• API reference -- all functions and classes
• Platform details -- per-platform paths and behavior

Why this fork?

This repository is a friendly fork of the wonderful work started by ActiveState who created appdirs, this package's ancestor.

Maintaining an open source project is no easy task, particularly from within an organization, and the Python community is indebted to appdirs (and to Trent Mick and Jeff Rouse in particular) for creating an incredibly useful simple module, as evidenced by the wide number of users it has attracted over the years.

Nonetheless, given the number of long-standing open issues and pull requests, and no clear path towards ensuring that maintenance of the package would continue or grow, this fork was created.

Contributions are most welcome.