summaryrefslogtreecommitdiff
path: root/portato/constants.py
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--portato/constants.py72
1 files changed, 41 insertions, 31 deletions
diff --git a/portato/constants.py b/portato/constants.py
index 3aea05d..c76b737 100644
--- a/portato/constants.py
+++ b/portato/constants.py
@@ -14,62 +14,72 @@
Constants used through out the program. Mainly different pathes.
These should be set during the installation.
+@var APP: the application name
+@type APP: string
@var VERSION: the current version
@type VERSION: string
+@var HOME: shortcut to $HOME
+@type HOME: string
+@var SU_COMMAND: command to execute to "su"
+@type SU_COMMAND: string
+@var USE_CATAPULT: use the catapult backend or the normal ones
+@type USE_CATAPULT: boolean
+
+@var FRONTENDS: the list of frontends which are installed
+@type FRONTENDS: string[]
+@var STD_FRONTEND: the frontend uses as the default, i.e. if no other one is given on the cmdline
+@type STD_FRONTEND: string
+
@var CONFIG_DIR: The configuration directory.
@type CONFIG_DIR: string
@var CONFIG_LOCATION: L{CONFIG_DIR} plus name of the config file.
@type CONFIG_LOCATION: string
-@var DATA_DIR: Directory which contains several data files (e.g. ui-files).
-@type DATA_DIR: string
-@var PLUGIN_DIR: Directory containing the plugin xmls.
-@type PLUGIN_DIR: string
-@var XSD_DIR: Directory containing the plugin-xml schema.
-@type XSD_DIR: string
-@var XSD_LOCATION: Path of the plugin schema.
-@type XSD_LOCATION: string
+
@var ICON_DIR: directory containing the icons
@type ICON_DIR: string
@var APP_ICON: the path of the application icon
@type APP_ICON: string
+
+@var DATA_DIR: Directory which contains all shared files.
+@type DATA_DIR: string
@var LOCALE_DIR: the path to the directory where the locale files (*.mo) are stored.
@type LOCALE_DIR: string
-@var FRONTENDS: the list of frontends which are installed
-@type FRONTENDS: string[]
-@var STD_FRONTEND: the frontend uses as the default, i.e. if no other one is given on the cmdline
-@type STD_FRONTEND: string
-@var SU_COMMAND: command to execute to "su"
-@type SU_COMMAND: string
+@var PLUGIN_DIR: Directory containing the plugin xmls.
+@type PLUGIN_DIR: string
+@var SETTINGS_DIR: Directory containing the user specific settings.
+@type SETTINGS_DIR: string
+@var TEMPLATE_DIR: Directory containing the UI template files.
+@type TEMPLATE_DIR: string
+@var XSD_LOCATION: Path of the plugin schema.
+@type XSD_LOCATION: string
"""
import os
from os.path import join as pjoin
-HOME = os.environ["HOME"]
-
+# general
APP = "portato"
VERSION = "9999"
+HOME = os.environ["HOME"]
+SU_COMMAND = "gksu -D 'Portato'"
+USE_CATAPULT = True
-SETTINGS_DIR = pjoin(HOME, "."+APP)
+# frontends
+FRONTENDS = ["gtk"]
+STD_FRONTEND = "gtk"
+# config
CONFIG_DIR = "/etc/portato/"
CONFIG_LOCATION = pjoin(CONFIG_DIR, "portato.cfg")
-VAR_DIR = "/var/portato/"
-
-DATA_DIR = "portato/gui/templates/"
-PLUGIN_DIR = "plugins/"
-
-XSD_DIR = "./"
-XSD_LOCATION = pjoin(XSD_DIR, "plugin.xsd")
-
+# icons
ICON_DIR = "icons/"
APP_ICON = pjoin(ICON_DIR, "portato-icon.png")
+# misc dirs
+DATA_DIR = "./"
LOCALE_DIR = "i18n/"
+PLUGIN_DIR = pjoin(DATA_DIR, "plugins/")
+SETTINGS_DIR = pjoin(HOME, "."+APP)
+TEMPLATE_DIR = "portato/gui/templates/"
-FRONTENDS = ["gtk"]
-STD_FRONTEND = "gtk"
-
-SU_COMMAND = "gksu -D 'Portato'"
-
-USE_CATAPULT = True
+XSD_LOCATION = pjoin(DATA_DIR, "plugin.xsd")