init
This commit is contained in:
commit
38355d2442
9083 changed files with 1225834 additions and 0 deletions
|
|
@ -0,0 +1 @@
|
|||
pip
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# This is the MIT license
|
||||
|
||||
Copyright (c) 2010 ActiveState Software Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included
|
||||
in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
||||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,249 @@
|
|||
Metadata-Version: 2.1
|
||||
Name: platformdirs
|
||||
Version: 2.5.1
|
||||
Summary: A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir".
|
||||
Home-page: https://github.com/platformdirs/platformdirs
|
||||
Maintainer: Bernát Gábor, Julian Berman, Ofek Lev, Ronny Pfannschmidt
|
||||
Maintainer-email: gaborjbernat@gmail.com, Julian@GrayVines.com, oss@ofek.dev, opensource@ronnypfannschmidt.de
|
||||
License: MIT
|
||||
Project-URL: Source, https://github.com/platformdirs/platformdirs
|
||||
Project-URL: Tracker, https://github.com/platformdirs/platformdirs/issues
|
||||
Project-URL: Documentation, https://platformdirs.readthedocs.io/
|
||||
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
|
||||
Classifier: Programming Language :: Python :: 3
|
||||
Classifier: Programming Language :: Python :: 3 :: Only
|
||||
Classifier: Programming Language :: Python :: 3.7
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||||
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Requires-Python: >=3.7
|
||||
Description-Content-Type: text/x-rst
|
||||
License-File: LICENSE.txt
|
||||
Provides-Extra: docs
|
||||
Requires-Dist: Sphinx (>=4) ; extra == 'docs'
|
||||
Requires-Dist: furo (>=2021.7.5b38) ; extra == 'docs'
|
||||
Requires-Dist: proselint (>=0.10.2) ; extra == 'docs'
|
||||
Requires-Dist: sphinx-autodoc-typehints (>=1.12) ; extra == 'docs'
|
||||
Provides-Extra: test
|
||||
Requires-Dist: appdirs (==1.4.4) ; extra == 'test'
|
||||
Requires-Dist: pytest (>=6) ; extra == 'test'
|
||||
Requires-Dist: pytest-cov (>=2.7) ; extra == 'test'
|
||||
Requires-Dist: pytest-mock (>=3.6) ; extra == 'test'
|
||||
|
||||
The problem
|
||||
===========
|
||||
|
||||
.. image:: https://github.com/platformdirs/platformdirs/workflows/Test/badge.svg
|
||||
:target: https://github.com/platformdirs/platformdirs/actions?query=workflow%3ATest
|
||||
|
||||
When writing desktop application, finding the right location to store user data
|
||||
and configuration varies per platform. Even for single-platform apps, there
|
||||
may by plenty of nuances in figuring out the right location.
|
||||
|
||||
For example, if running on macOS, 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 <https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-vista/cc766489(v=ws.10)>`_ but that is another story.
|
||||
|
||||
On Linux (and other Unices), according to the `XDG Basedir Spec`_, it should be::
|
||||
|
||||
~/.local/share/<AppName>
|
||||
|
||||
.. _XDG Basedir Spec: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
|
||||
|
||||
``platformdirs`` to the rescue
|
||||
==============================
|
||||
|
||||
This kind of thing is what the ``platformdirs`` module is for.
|
||||
``platformdirs`` 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``)
|
||||
- user documents dir (``user_documents_dir``)
|
||||
- user runtime dir (``user_runtime_dir``)
|
||||
|
||||
And also:
|
||||
|
||||
- Is a single module so other Python packages can vendor 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.
|
||||
|
||||
Example output
|
||||
==============
|
||||
|
||||
On macOS:
|
||||
|
||||
.. code-block:: pycon
|
||||
|
||||
>>> from platformdirs 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'
|
||||
>>> user_documents_dir()
|
||||
'/Users/trentm/Documents'
|
||||
>>> user_runtime_dir(appname, appauthor)
|
||||
'/Users/trentm/Library/Caches/TemporaryItems/SuperApp'
|
||||
|
||||
On Windows 7:
|
||||
|
||||
.. code-block:: pycon
|
||||
|
||||
>>> from platformdirs 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'
|
||||
>>> user_documents_dir()
|
||||
'C:\\Users\\trentm\\Documents'
|
||||
>>> user_runtime_dir(appname, appauthor)
|
||||
'C:\\Users\\trentm\\AppData\\Local\\Temp\\Acme\\SuperApp'
|
||||
|
||||
On Linux:
|
||||
|
||||
.. code-block:: pycon
|
||||
|
||||
>>> from platformdirs 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'
|
||||
>>> user_documents_dir()
|
||||
'/home/trentm/Documents'
|
||||
>>> user_runtime_dir(appname, appauthor)
|
||||
'/run/user/{os.getuid()}/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'
|
||||
|
||||
On Android::
|
||||
|
||||
>>> from platformdirs import *
|
||||
>>> appname = "SuperApp"
|
||||
>>> appauthor = "Acme"
|
||||
>>> user_data_dir(appname, appauthor)
|
||||
'/data/data/com.termux/files/SuperApp'
|
||||
>>> user_cache_dir(appname, appauthor)
|
||||
'/data/data/com.termux/cache/SuperApp'
|
||||
>>> user_log_dir(appname, appauthor)
|
||||
'/data/data/com.termux/cache/SuperApp/log'
|
||||
>>> user_config_dir(appname)
|
||||
'/data/data/com.termux/shared_prefs/SuperApp'
|
||||
>>> user_documents_dir()
|
||||
'/storage/emulated/0/Documents'
|
||||
>>> user_runtime_dir(appname, appauthor)
|
||||
'/data/data/com.termux/cache/SuperApp/tmp'
|
||||
|
||||
``PlatformDirs`` for convenience
|
||||
================================
|
||||
|
||||
.. code-block:: pycon
|
||||
|
||||
>>> from platformdirs import PlatformDirs
|
||||
>>> dirs = PlatformDirs("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'
|
||||
>>> dirs.user_documents_dir
|
||||
'/Users/trentm/Documents'
|
||||
>>> dirs.user_runtime_dir
|
||||
'/Users/trentm/Library/Caches/TemporaryItems/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 platformdirs import PlatformDirs
|
||||
>>> dirs = PlatformDirs("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'
|
||||
>>> dirs.user_documents_dir
|
||||
'/Users/trentm/Documents'
|
||||
>>> dirs.user_runtime_dir
|
||||
'/Users/trentm/Library/Caches/TemporaryItems/SuperApp/1.0'
|
||||
|
||||
Be wary of using this for configuration files though; you'll need to handle
|
||||
migrating configuration files manually.
|
||||
|
||||
Why this Fork?
|
||||
==============
|
||||
|
||||
This repository is a friendly fork of the wonderful work started by
|
||||
`ActiveState <https://github.com/ActiveState/appdirs>`_ who created
|
||||
``appdirs``, this package's ancestor.
|
||||
|
||||
Maintaining an open source project is no easy task, particularly
|
||||
from within an organization, and the Python community is indebted
|
||||
to ``appdirs`` (and to Trent Mick and Jeff Rouse in particular) for
|
||||
creating an incredibly useful simple module, as evidenced by the wide
|
||||
number of users it has attracted over the years.
|
||||
|
||||
Nonetheless, given the number of long-standing open issues
|
||||
and pull requests, and no clear path towards `ensuring
|
||||
that maintenance of the package would continue or grow
|
||||
<https://github.com/ActiveState/appdirs/issues/79>`_, this fork was
|
||||
created.
|
||||
|
||||
Contributions are most welcome.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
platformdirs-2.5.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
platformdirs-2.5.1.dist-info/LICENSE.txt,sha256=1l7lsqNqOR6Nau_OuArlAGMEml2xS8gk7g8eusmXDlA,1096
|
||||
platformdirs-2.5.1.dist-info/METADATA,sha256=MT26r5rQA2tJbP8D_wm-mtDZZeDx6vvUsD-DZODNHlg,9139
|
||||
platformdirs-2.5.1.dist-info/RECORD,,
|
||||
platformdirs-2.5.1.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
|
||||
platformdirs-2.5.1.dist-info/top_level.txt,sha256=i0Q-nUAcPabcNxrgdGr0mzOEavZ4cGml0zH0oxKEFQE,13
|
||||
platformdirs-2.5.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
||||
platformdirs/__init__.py,sha256=n5barrjjLRd9At0RYY4pjKMb98bnpWBwwVc3ZOBkpuI,12688
|
||||
platformdirs/__main__.py,sha256=VsC0t5m-6f0YVr96PVks93G3EDF8MSNY4KpUMvPahDA,1164
|
||||
platformdirs/__pycache__/__init__.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/__main__.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/android.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/api.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/macos.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/unix.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/version.cpython-38.pyc,,
|
||||
platformdirs/__pycache__/windows.cpython-38.pyc,,
|
||||
platformdirs/android.py,sha256=GKizhyS7ESRiU67u8UnBJLm46goau9937EchXWbPBlk,4068
|
||||
platformdirs/api.py,sha256=MXKHXOL3eh_-trSok-JUTjAR_zjmmKF3rjREVABjP8s,4910
|
||||
platformdirs/macos.py,sha256=-3UXQewbT0yMhMdkzRXfXGAntmLIH7Qt4a9Hlf8I5_Y,2655
|
||||
platformdirs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
platformdirs/unix.py,sha256=b4aVYTz0qZ50HntwOXo8r6tp82jAa3qTjxw-WlnC2yc,6910
|
||||
platformdirs/version.py,sha256=vYD-L_Eg2ytekxltvPgbkHTNgLD8A56MZS7bJcEhjzI,80
|
||||
platformdirs/windows.py,sha256=ISruopR5UGBePC0BxCxXevkZYfjJsIZc49YWU5iYfQ4,6439
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Wheel-Version: 1.0
|
||||
Generator: bdist_wheel (0.37.1)
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
platformdirs
|
||||
|
|
@ -0,0 +1 @@
|
|||
|
||||
Loading…
Add table
Add a link
Reference in a new issue