Module directories

Contains methods for working with directories that have special meanings to the software.

This module attempts to follow the conventions for each platform’s guidelines, and as a result the paths generated for each platform may differ.

Inspiration of this library was taken from directories. The library wasn’t used due to licensing issues.

Below are the conventions followed for each platform:

• Windows: Known Folder API
• Linux: XDG Base Directory specifications.
• macOS: Standard Directories.

Enums

DirectoryError

Contains the errors that can occur when attempting to retrieve one of the known directories.

Functions

cache_path

Attempts to retrieve the current platform’s cache directory.

cache_path_linux 🔒

config_path

Attempts to retrieve the current platform’s configuration directory.

config_path_linux 🔒