Mercurial > repos > shellac > guppy_basecaller

comparison env/lib/python3.7/site-packages/appdirs-1.4.3.dist-info/METADATA @ 0:26e78fe6e8c4 draft

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