File: PKG-INFO

package info (click to toggle)
appdirs 1.4.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 184 kB
  • sloc: python: 573; makefile: 11; sh: 8
file content (262 lines) | stat: -rw-r--r-- 10,868 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
Metadata-Version: 1.2
Name: appdirs
Version: 1.4.4
Summary: A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir".
Home-page: http://github.com/ActiveState/appdirs
Author: Trent Mick
Author-email: trentm@gmail.com
Maintainer: Jeff Rouse
Maintainer-email: jr@its.to
License: MIT
Description: 
        .. image:: https://secure.travis-ci.org/ActiveState/appdirs.png
            :target: http://travis-ci.org/ActiveState/appdirs
        
        the problem
        ===========
        
        What directory should your app use for storing user data? If running on Mac OS X, you
        should use::
        
            ~/Library/Application Support/<AppName>
        
        If on Windows (at least English Win XP) that should be::
        
            C:\Documents and Settings\<User>\Application Data\Local Settings\<AppAuthor>\<AppName>
        
        or possibly::
        
            C:\Documents and Settings\<User>\Application Data\<AppAuthor>\<AppName>
        
        for `roaming profiles <http://bit.ly/9yl3b6>`_ but that is another story.
        
        On Linux (and other Unices) the dir, according to the `XDG
        spec <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_, is::
        
            ~/.local/share/<AppName>
        
        
        ``appdirs`` to the rescue
        =========================
        
        This kind of thing is what the ``appdirs`` module is for. ``appdirs`` will
        help you choose an appropriate:
        
        - user data dir (``user_data_dir``)
        - user config dir (``user_config_dir``)
        - user cache dir (``user_cache_dir``)
        - site data dir (``site_data_dir``)
        - site config dir (``site_config_dir``)
        - user log dir (``user_log_dir``)
        
        and also:
        
        - is a single module so other Python packages can include their own private copy
        - is slightly opinionated on the directory names used. Look for "OPINION" in
          documentation and code for when an opinion is being applied.
        
        
        some example output
        ===================
        
        On Mac OS X::
        
            >>> from appdirs import *
            >>> appname = "SuperApp"
            >>> appauthor = "Acme"
            >>> user_data_dir(appname, appauthor)
            '/Users/trentm/Library/Application Support/SuperApp'
            >>> site_data_dir(appname, appauthor)
            '/Library/Application Support/SuperApp'
            >>> user_cache_dir(appname, appauthor)
            '/Users/trentm/Library/Caches/SuperApp'
            >>> user_log_dir(appname, appauthor)
            '/Users/trentm/Library/Logs/SuperApp'
        
        On Windows 7::
        
            >>> from appdirs import *
            >>> appname = "SuperApp"
            >>> appauthor = "Acme"
            >>> user_data_dir(appname, appauthor)
            'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
            >>> user_data_dir(appname, appauthor, roaming=True)
            'C:\\Users\\trentm\\AppData\\Roaming\\Acme\\SuperApp'
            >>> user_cache_dir(appname, appauthor)
            'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Cache'
            >>> user_log_dir(appname, appauthor)
            'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Logs'
        
        On Linux::
        
            >>> from appdirs import *
            >>> appname = "SuperApp"
            >>> appauthor = "Acme"
            >>> user_data_dir(appname, appauthor)
            '/home/trentm/.local/share/SuperApp
            >>> site_data_dir(appname, appauthor)
            '/usr/local/share/SuperApp'
            >>> site_data_dir(appname, appauthor, multipath=True)
            '/usr/local/share/SuperApp:/usr/share/SuperApp'
            >>> user_cache_dir(appname, appauthor)
            '/home/trentm/.cache/SuperApp'
            >>> user_log_dir(appname, appauthor)
            '/home/trentm/.cache/SuperApp/log'
            >>> user_config_dir(appname)
            '/home/trentm/.config/SuperApp'
            >>> site_config_dir(appname)
            '/etc/xdg/SuperApp'
            >>> os.environ['XDG_CONFIG_DIRS'] = '/etc:/usr/local/etc'
            >>> site_config_dir(appname, multipath=True)
            '/etc/SuperApp:/usr/local/etc/SuperApp'
        
        
        ``AppDirs`` for convenience
        ===========================
        
        ::
        
            >>> from appdirs import AppDirs
            >>> dirs = AppDirs("SuperApp", "Acme")
            >>> dirs.user_data_dir
            '/Users/trentm/Library/Application Support/SuperApp'
            >>> dirs.site_data_dir
            '/Library/Application Support/SuperApp'
            >>> dirs.user_cache_dir
            '/Users/trentm/Library/Caches/SuperApp'
            >>> dirs.user_log_dir
            '/Users/trentm/Library/Logs/SuperApp'
        
        
            
        Per-version isolation
        =====================
        
        If you have multiple versions of your app in use that you want to be
        able to run side-by-side, then you may want version-isolation for these
        dirs::
        
            >>> from appdirs import AppDirs
            >>> dirs = AppDirs("SuperApp", "Acme", version="1.0")
            >>> dirs.user_data_dir
            '/Users/trentm/Library/Application Support/SuperApp/1.0'
            >>> dirs.site_data_dir
            '/Library/Application Support/SuperApp/1.0'
            >>> dirs.user_cache_dir
            '/Users/trentm/Library/Caches/SuperApp/1.0'
            >>> dirs.user_log_dir
            '/Users/trentm/Library/Logs/SuperApp/1.0'
        
        
        
        appdirs Changelog
        =================
        
        appdirs 1.4.4
        -------------
        - [PR #92] Don't import appdirs from setup.py
        
        Project officially classified as Stable which is important
        for inclusion in other distros such as ActivePython.
        
        First of several incremental releases to catch up on maintenance.
        
        appdirs 1.4.3
        -------------
        - [PR #76] Python 3.6 invalid escape sequence deprecation fixes
        - Fix for Python 3.6 support
        
        appdirs 1.4.2
        -------------
        - [PR #84] Allow installing without setuptools
        - [PR #86] Fix string delimiters in setup.py description
        - Add Python 3.6 support
        
        appdirs 1.4.1
        -------------
        - [issue #38] Fix _winreg import on Windows Py3
        - [issue #55] Make appname optional
        
        appdirs 1.4.0
        -------------
        - [PR #42] AppAuthor is now optional on Windows
        - [issue 41] Support Jython on Windows, Mac, and Unix-like platforms. Windows
          support requires `JNA <https://github.com/twall/jna>`_.
        - [PR #44] Fix incorrect behaviour of the site_config_dir method
        
        appdirs 1.3.0
        -------------
        - [Unix, issue 16] Conform to XDG standard, instead of breaking it for
          everybody
        - [Unix] Removes gratuitous case mangling of the case, since \*nix-es are
          usually case sensitive, so mangling is not wise
        - [Unix] Fixes the utterly wrong behaviour in ``site_data_dir``, return result
          based on XDG_DATA_DIRS and make room for respecting the standard which
          specifies XDG_DATA_DIRS is a multiple-value variable
        - [Issue 6] Add ``*_config_dir`` which are distinct on nix-es, according to
          XDG specs; on Windows and Mac return the corresponding ``*_data_dir``
        
        appdirs 1.2.0
        -------------
        
        - [Unix] Put ``user_log_dir`` under the *cache* dir on Unix. Seems to be more
          typical.
        - [issue 9] Make ``unicode`` work on py3k.
        
        appdirs 1.1.0
        -------------
        
        - [issue 4] Add ``AppDirs.user_log_dir``.
        - [Unix, issue 2, issue 7] appdirs now conforms to `XDG base directory spec
          <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
        - [Mac, issue 5] Fix ``site_data_dir()`` on Mac.
        - [Mac] Drop use of 'Carbon' module in favour of hardcoded paths; supports
          Python3 now.
        - [Windows] Append "Cache" to ``user_cache_dir`` on Windows by default. Use
          ``opinion=False`` option to disable this.
        - Add ``appdirs.AppDirs`` convenience class. Usage:
        
                >>> dirs = AppDirs("SuperApp", "Acme", version="1.0")
                >>> dirs.user_data_dir
                '/Users/trentm/Library/Application Support/SuperApp/1.0'
        
        - [Windows] Cherry-pick Komodo's change to downgrade paths to the Windows short
          paths if there are high bit chars.
        - [Linux] Change default ``user_cache_dir()`` on Linux to be singular, e.g.
          "~/.superapp/cache".
        - [Windows] Add ``roaming`` option to ``user_data_dir()`` (for use on Windows only)
          and change the default ``user_data_dir`` behaviour to use a *non*-roaming
          profile dir (``CSIDL_LOCAL_APPDATA`` instead of ``CSIDL_APPDATA``). Why? Because
          a large roaming profile can cause login speed issues. The "only syncs on
          logout" behaviour can cause surprises in appdata info.
        
        
        appdirs 1.0.1 (never released)
        ------------------------------
        
        Started this changelog 27 July 2010. Before that this module originated in the
        `Komodo <http://www.activestate.com/komodo>`_ product as ``applib.py`` and then
        as `applib/location.py
        <http://github.com/ActiveState/applib/blob/master/applib/location.py>`_ (used by
        `PyPM <http://code.activestate.com/pypm/>`_ in `ActivePython
        <http://www.activestate.com/activepython>`_). This is basically a fork of
        applib.py 1.0.1 and applib/location.py 1.0.1.
        
        
Keywords: application directory log cache user
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules