1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
Name: platformdirs
3
- Version: 4.2.2
3
+ Version: 4.4.0
4
4
Summary: A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`.
5
+ Project-URL: Changelog, https://github.com/tox-dev/platformdirs/releases
5
6
Project-URL: Documentation, https://platformdirs.readthedocs.io
6
- Project-URL: Homepage, https://github.com/platformdirs /platformdirs
7
- Project-URL: Source, https://github.com/platformdirs /platformdirs
8
- Project-URL: Tracker, https://github.com/platformdirs /platformdirs/issues
7
+ Project-URL: Homepage, https://github.com/tox-dev /platformdirs
8
+ Project-URL: Source, https://github.com/tox-dev /platformdirs
9
+ Project-URL: Tracker, https://github.com/tox-dev /platformdirs/issues
9
10
Maintainer-email: Bernát Gábor <
[email protected] >, Julian Berman <
[email protected] >, Ofek Lev <
[email protected] >, Ronny Pfannschmidt <
[email protected] >
10
11
License-Expression: MIT
11
12
License-File: LICENSE
@@ -16,35 +17,41 @@ Classifier: License :: OSI Approved :: MIT License
16
17
Classifier: Operating System :: OS Independent
17
18
Classifier: Programming Language :: Python
18
19
Classifier: Programming Language :: Python :: 3 :: Only
19
- Classifier: Programming Language :: Python :: 3.8
20
20
Classifier: Programming Language :: Python :: 3.9
21
21
Classifier: Programming Language :: Python :: 3.10
22
22
Classifier: Programming Language :: Python :: 3.11
23
23
Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
24
25
Classifier: Programming Language :: Python :: Implementation :: CPython
25
26
Classifier: Programming Language :: Python :: Implementation :: PyPy
26
27
Classifier: Topic :: Software Development :: Libraries :: Python Modules
27
- Requires-Python: >=3.8
28
+ Requires-Python: >=3.9
28
29
Provides-Extra: docs
29
- Requires-Dist: furo>=2023.9.10 ; extra == 'docs'
30
- Requires-Dist: proselint>=0.13 ; extra == 'docs'
31
- Requires-Dist: sphinx-autodoc-typehints>=1.25.2 ; extra == 'docs'
32
- Requires-Dist: sphinx>=7.2.6 ; extra == 'docs'
30
+ Requires-Dist: furo>=2024.8.6 ; extra == 'docs'
31
+ Requires-Dist: proselint>=0.14 ; extra == 'docs'
32
+ Requires-Dist: sphinx-autodoc-typehints>=3 ; extra == 'docs'
33
+ Requires-Dist: sphinx>=8.1.3 ; extra == 'docs'
33
34
Provides-Extra: test
34
35
Requires-Dist: appdirs==1.4.4; extra == 'test'
35
36
Requires-Dist: covdefaults>=2.3; extra == 'test'
36
- Requires-Dist: pytest-cov>=4.1 ; extra == 'test'
37
- Requires-Dist: pytest-mock>=3.12 ; extra == 'test'
38
- Requires-Dist: pytest>=7.4.3 ; extra == 'test'
37
+ Requires-Dist: pytest-cov>=6 ; extra == 'test'
38
+ Requires-Dist: pytest-mock>=3.14 ; extra == 'test'
39
+ Requires-Dist: pytest>=8.3.4 ; extra == 'test'
39
40
Provides-Extra: type
40
- Requires-Dist: mypy>=1.8 ; extra == 'type'
41
+ Requires-Dist: mypy>=1.14.1 ; extra == 'type'
41
42
Description-Content-Type: text/x-rst
42
43
43
44
The problem
44
45
===========
45
46
46
- .. image:: https://github.com/platformdirs/platformdirs/actions/workflows/check.yml/badge.svg
47
+ .. image:: https://badge.fury.io/py/platformdirs.svg
48
+ :target: https://badge.fury.io/py/platformdirs
49
+ .. image:: https://img.shields.io/pypi/pyversions/platformdirs.svg
50
+ :target: https://pypi.python.org/pypi/platformdirs/
51
+ .. image:: https://github.com/tox-dev/platformdirs/actions/workflows/check.yaml/badge.svg
47
52
:target: https://github.com/platformdirs/platformdirs/actions
53
+ .. image:: https://static.pepy.tech/badge/platformdirs/month
54
+ :target: https://pepy.tech/project/platformdirs
48
55
49
56
When writing desktop application, finding the right location to store user data
50
57
and configuration varies per platform. Even for single-platform apps, there
@@ -107,10 +114,14 @@ On macOS:
107
114
>>> appauthor = "Acme"
108
115
>>> user_data_dir(appname, appauthor)
109
116
'/Users/trentm/Library/Application Support/SuperApp'
110
- >>> site_data_dir (appname, appauthor)
111
- '/Library/Application Support/SuperApp'
117
+ >>> user_config_dir (appname, appauthor)
118
+ '/Users/trentm/ Library/Application Support/SuperApp'
112
119
>>> user_cache_dir(appname, appauthor)
113
120
'/Users/trentm/Library/Caches/SuperApp'
121
+ >>> site_data_dir(appname, appauthor)
122
+ '/Library/Application Support/SuperApp'
123
+ >>> site_config_dir(appname, appauthor)
124
+ '/Library/Application Support/SuperApp'
114
125
>>> user_log_dir(appname, appauthor)
115
126
'/Users/trentm/Library/Logs/SuperApp'
116
127
>>> user_documents_dir()
@@ -139,8 +150,14 @@ On Windows:
139
150
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
140
151
>>> user_data_dir(appname, appauthor, roaming=True)
141
152
'C:\\Users\\trentm\\AppData\\Roaming\\Acme\\SuperApp'
153
+ >>> user_config_dir(appname, appauthor)
154
+ 'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp'
142
155
>>> user_cache_dir(appname, appauthor)
143
156
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Cache'
157
+ >>> site_data_dir(appname, appauthor)
158
+ 'C:\\ProgramData\\Acme\\SuperApp'
159
+ >>> site_config_dir(appname, appauthor)
160
+ 'C:\\ProgramData\\Acme\\SuperApp'
144
161
>>> user_log_dir(appname, appauthor)
145
162
'C:\\Users\\trentm\\AppData\\Local\\Acme\\SuperApp\\Logs'
146
163
>>> user_documents_dir()
@@ -167,16 +184,21 @@ On Linux:
167
184
>>> appauthor = "Acme"
168
185
>>> user_data_dir(appname, appauthor)
169
186
'/home/trentm/.local/share/SuperApp'
187
+ >>> user_config_dir(appname)
188
+ '/home/trentm/.config/SuperApp'
189
+ >>> user_cache_dir(appname, appauthor)
190
+ '/home/trentm/.cache/SuperApp'
170
191
>>> site_data_dir(appname, appauthor)
171
192
'/usr/local/share/SuperApp'
172
193
>>> site_data_dir(appname, appauthor, multipath=True)
173
194
'/usr/local/share/SuperApp:/usr/share/SuperApp'
174
- >>> user_cache_dir(appname, appauthor)
175
- '/home/trentm/.cache/SuperApp'
195
+ >>> site_config_dir(appname)
196
+ '/etc/xdg/SuperApp'
197
+ >>> os.environ["XDG_CONFIG_DIRS"] = "/etc:/usr/local/etc"
198
+ >>> site_config_dir(appname, multipath=True)
199
+ '/etc/SuperApp:/usr/local/etc/SuperApp'
176
200
>>> user_log_dir(appname, appauthor)
177
201
'/home/trentm/.local/state/SuperApp/log'
178
- >>> user_config_dir(appname)
179
- '/home/trentm/.config/SuperApp'
180
202
>>> user_documents_dir()
181
203
'/home/trentm/Documents'
182
204
>>> user_downloads_dir()
@@ -191,11 +213,6 @@ On Linux:
191
213
'/home/trentm/Desktop'
192
214
>>> user_runtime_dir(appname, appauthor)
193
215
'/run/user/{os.getuid()}/SuperApp'
194
- >>> site_config_dir(appname)
195
- '/etc/xdg/SuperApp'
196
- >>> os.environ["XDG_CONFIG_DIRS"] = "/etc:/usr/local/etc"
197
- >>> site_config_dir(appname, multipath=True)
198
- '/etc/SuperApp:/usr/local/etc/SuperApp'
199
216
200
217
On Android::
201
218
@@ -204,12 +221,16 @@ On Android::
204
221
>>> appauthor = "Acme"
205
222
>>> user_data_dir(appname, appauthor)
206
223
'/data/data/com.myApp/files/SuperApp'
224
+ >>> user_config_dir(appname)
225
+ '/data/data/com.myApp/shared_prefs/SuperApp'
207
226
>>> user_cache_dir(appname, appauthor)
208
227
'/data/data/com.myApp/cache/SuperApp'
228
+ >>> site_data_dir(appname, appauthor)
229
+ '/data/data/com.myApp/files/SuperApp'
230
+ >>> site_config_dir(appname)
231
+ '/data/data/com.myApp/shared_prefs/SuperApp'
209
232
>>> user_log_dir(appname, appauthor)
210
233
'/data/data/com.myApp/cache/SuperApp/log'
211
- >>> user_config_dir(appname)
212
- '/data/data/com.myApp/shared_prefs/SuperApp'
213
234
>>> user_documents_dir()
214
235
'/storage/emulated/0/Documents'
215
236
>>> user_downloads_dir()
@@ -241,8 +262,14 @@ apps also support ``XDG_*`` environment variables.
241
262
>>> dirs = PlatformDirs("SuperApp", "Acme")
242
263
>>> dirs.user_data_dir
243
264
'/Users/trentm/Library/Application Support/SuperApp'
265
+ >>> dirs.user_config_dir
266
+ '/Users/trentm/Library/Application Support/SuperApp'
267
+ >>> dirs.user_cache_dir
268
+ '/Users/trentm/Library/Caches/SuperApp'
244
269
>>> dirs.site_data_dir
245
270
'/Library/Application Support/SuperApp'
271
+ >>> dirs.site_config_dir
272
+ '/Library/Application Support/SuperApp'
246
273
>>> dirs.user_cache_dir
247
274
'/Users/trentm/Library/Caches/SuperApp'
248
275
>>> dirs.user_log_dir
@@ -273,10 +300,14 @@ dirs::
273
300
>>> dirs = PlatformDirs("SuperApp", "Acme", version="1.0")
274
301
>>> dirs.user_data_dir
275
302
'/Users/trentm/Library/Application Support/SuperApp/1.0'
276
- >>> dirs.site_data_dir
277
- '/Library/Application Support/SuperApp/1.0'
303
+ >>> dirs.user_config_dir
304
+ '/Users/trentm/ Library/Application Support/SuperApp/1.0'
278
305
>>> dirs.user_cache_dir
279
306
'/Users/trentm/Library/Caches/SuperApp/1.0'
307
+ >>> dirs.site_data_dir
308
+ '/Library/Application Support/SuperApp/1.0'
309
+ >>> dirs.site_config_dir
310
+ '/Library/Application Support/SuperApp/1.0'
280
311
>>> dirs.user_log_dir
281
312
'/Users/trentm/Library/Logs/SuperApp/1.0'
282
313
>>> dirs.user_documents_dir
0 commit comments