bucket_1A/python-appdirs

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-appdirs
   4 VERSION=                1.4.4
   5 KEYWORDS=               python
   6 VARIANTS=               py38 py39
   7 SDESC[py38]=            Determines platform-specific directores (PY38)
   8 SDESC[py39]=            Determines platform-specific directores (PY39)
   9 HOMEPAGE=               https://github.com/ActiveState/appdirs
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/3b/00/2344469e2084fb287c2e0b57b72910309874c3245463acd6cf5e3db69324
  14 DISTFILE[1]=            appdirs-1.4.4-py2.py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py38]=            single
  17 SPKGS[py39]=            single
  18
  19 OPTIONS_AVAILABLE=      PY38 PY39
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py38]=            PY38=ON PY39=OFF
  22 VOPTS[py39]=            PY38=OFF PY39=ON
  23
  24 DISTNAME=               appdirs-1.4.4.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY38].USES_ON=                         python:py38,wheel
  29
  30 [PY39].USES_ON=                         python:py39,wheel
  31
  32 [FILE:2931:descriptions/desc.single]
  33
  34
  35 the problem
  36 ===========
  37
  38 What directory should your app use for storing user data? If running on Mac
  39 OS X, you
  40 should use::
  41
  42     ~/Library/Application Support/<AppName>
  43
  44 If on Windows (at least English Win XP) that should be::
  45
  46     C:\Documents and Settings\<User>\Application Data\Local
  47 Settings\<AppAuthor>\<AppName>
  48
  49 or possibly::
  50
  51     C:\Documents and Settings\<User>\Application Data\<AppAuthor>\<AppName>
  52
  53 for [roaming profiles] but that is another story.
  54
  55 On Linux (and other Unices) the dir, according to the [XDG
  56 spec], is::
  57
  58     ~/.local/share/<AppName>
  59
  60 appdirs to the rescue
  61 =========================
  62
  63 This kind of thing is what the appdirs module is for. appdirs will
  64 help you choose an appropriate:
  65
  66 - user data dir (user_data_dir)
  67 - user config dir (user_config_dir)
  68 - user cache dir (user_cache_dir)
  69 - site data dir (site_data_dir)
  70 - site config dir (site_config_dir)
  71 - user log dir (user_log_dir)
  72
  73 and also:
  74
  75 - is a single module so other Python packages can include their own private
  76 copy
  77 - is slightly opinionated on the directory names used. Look for "OPINION"
  78 in
  79   documentation and code for when an opinion is being applied.
  80
  81 some example output
  82 ===================
  83
  84 On Mac OS X::
  85
  86     >>> from appdirs import *
  87     >>> appname = "SuperApp"
  88     >>> appauthor = "Acme"
  89     >>> user_data_dir(appname, appauthor)
  90     '/Users/trentm/Library/Application Support/SuperApp'
  91     >>> site_data_dir(appname, appauthor)
  92     '/Library/Application Support/SuperApp'
  93     >>> user_cache_dir(appname, appauthor)
  94     '/Users/trentm/Library/Caches/SuperApp'
  95     >>> user_log_dir(appname, appauthor)
  96     '/Users/trentm/Library/Logs/SuperApp'
  97
  98 On Windows 7::
  99
 100     >>> from appdirs import *
 101     >>> appname = "SuperApp"
 102     >>> appauthor = "Acme"
 103     >>> user_data_dir(appname, appauthor)
 104     'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
 105     >>> user_data_dir(appname, appauthor, roaming=True)
 106     'C:\\Users\\trentm\\AppData\\Roaming\\Acme\\SuperApp'
 107     >>> user_cache_dir(appname, appauthor)
 108     'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Cache'
 109     >>> user_log_dir(appname, appauthor)
 110     'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Logs'
 111
 112 On Linux::
 113
 114     >>> from appdirs import *
 115     >>> appname = "SuperApp"
 116     >>> appauthor = "Acme"
 117     >>> user_data_dir(appname, appauthor)
 118     '/home/trentm/.local/share/SuperApp
 119     >>> site_data_dir(appname, appauthor)
 120     '/usr/local/share/SuperApp'
 121     >>> site_data_dir(appname, appauthor, multipath=True)
 122     '/usr/local/share/SuperApp:/usr/share/SuperApp'
 123     >>> user_cache_dir(appname, appauthor)
 124     '/home/trentm/.cache/SuperApp'
 125     >>> user_log_dir(appname, appauthor)
 126     '/home/trentm/.cache/SuperApp/log'
 127     >>> user_config_dir(appname)
 128     '/home/trentm/.config/SuperApp'
 129     >>> site_config_dir(appname)
 130     '/etc/xdg/SuperApp'
 131     >>> os.environ['XDG_CONFIG_DIRS'] = '/etc:/usr/local/etc'
 132     >>> site_config_dir(appname, multipath=True)
 133
 134
 135 [FILE:113:distinfo]
 136 a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128         9566 appdirs-1.4.4-py2.py3-none-any.whl
 137