Skip to main content

Variables defined by the XDG Base Directory Specification

Project description

https://img.shields.io/travis/srstevenson/xdg.svg?maxAge=2592000 https://img.shields.io/github/tag/srstevenson/xdg.svg?maxAge=2592000 https://img.shields.io/pypi/v/xdg.svg?maxAge=2592000

xdg is a tiny Python module which provides the variables defined by the XDG Base Directory Specification, to save you from duplicating the same snippet of logic in every Python utility you write that deals with user cache, configuration, or data files. It has no external dependencies.

Installation

To install the latest release from PyPI, use pip:

pip install xdg

Alternatively, since xdg is only a single file you may prefer to just copy xdg.py from the source distribution into your project.

Usage

from xdg import (XDG_CACHE_HOME, XDG_CONFIG_DIRS, XDG_CONFIG_HOME,
                 XDG_DATA_DIRS, XDG_DATA_HOME, XDG_RUNTIME_DIR)

XDG_CACHE_HOME, XDG_CONFIG_HOME, and XDG_DATA_HOME are strings containing the value of the environment variable of the same name, or the default defined in the specification if the environment variable is unset or empty.

XDG_CONFIG_DIRS and XDG_DATA_DIRS are lists of strings containing the value of the environment variable of the same name split on colons, or the default defined in the specification if the environment variable is unset or empty.

XDG_RUNTIME_DIR is a string containing the value of the environment variable of the same name, or None if the environment variable is unset.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xdg, version 3.0.0
Filename, size File type Python version Upload date Hashes
Filename, size xdg-3.0.0-py2.py3-none-any.whl (5.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size xdg-3.0.0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page