{ "info": { "author": "Trent Mick; Sridhar Ratnakumar; Jeff Rouse", "author_email": "trentm@gmail.com; github@srid.name; jr@its.to", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "\n.. image:: https://secure.travis-ci.org/ActiveState/appdirs.png\n :target: http://travis-ci.org/ActiveState/appdirs\n\nthe problem\n===========\n\nWhat directory should your app use for storing user data? If running on Mac OS X, you\nshould use::\n\n ~/Library/Application Support/\n\nIf on Windows (at least English Win XP) that should be::\n\n C:\\Documents and Settings\\\\Application Data\\Local Settings\\\\\n\nor possibly::\n\n C:\\Documents and Settings\\\\Application Data\\\\\n\nfor `roaming profiles `_ but that is another story.\n\nOn Linux (and other Unices) the dir, according to the `XDG\nspec `_, is::\n\n ~/.local/share/\n\n\n``appdirs`` to the rescue\n=========================\n\nThis kind of thing is what the ``appdirs`` module is for. ``appdirs`` will\nhelp you choose an appropriate:\n\n- user data dir (``user_data_dir``)\n- user config dir (``user_config_dir``)\n- user cache dir (``user_cache_dir``)\n- site data dir (``site_data_dir``)\n- site config dir (``site_config_dir``)\n- user log dir (``user_log_dir``)\n\nand also:\n\n- is a single module so other Python packages can include their own private copy\n- is slightly opinionated on the directory names used. Look for \"OPINION\" in\n documentation and code for when an opinion is being applied.\n\n\nsome example output\n===================\n\nOn Mac OS X::\n\n >>> from appdirs import *\n >>> appname = \"SuperApp\"\n >>> appauthor = \"Acme\"\n >>> user_data_dir(appname, appauthor)\n '/Users/trentm/Library/Application Support/SuperApp'\n >>> site_data_dir(appname, appauthor)\n '/Library/Application Support/SuperApp'\n >>> user_cache_dir(appname, appauthor)\n '/Users/trentm/Library/Caches/SuperApp'\n >>> user_log_dir(appname, appauthor)\n '/Users/trentm/Library/Logs/SuperApp'\n\nOn Windows 7::\n\n >>> from appdirs import *\n >>> appname = \"SuperApp\"\n >>> appauthor = \"Acme\"\n >>> user_data_dir(appname, appauthor)\n 'C:\\\\Users\\\\trentm\\\\AppData\\\\Local\\\\Acme\\\\SuperApp'\n >>> user_data_dir(appname, appauthor, roaming=True)\n 'C:\\\\Users\\\\trentm\\\\AppData\\\\Roaming\\\\Acme\\\\SuperApp'\n >>> user_cache_dir(appname, appauthor)\n 'C:\\\\Users\\\\trentm\\\\AppData\\\\Local\\\\Acme\\\\SuperApp\\\\Cache'\n >>> user_log_dir(appname, appauthor)\n 'C:\\\\Users\\\\trentm\\\\AppData\\\\Local\\\\Acme\\\\SuperApp\\\\Logs'\n\nOn Linux::\n\n >>> from appdirs import *\n >>> appname = \"SuperApp\"\n >>> appauthor = \"Acme\"\n >>> user_data_dir(appname, appauthor)\n '/home/trentm/.local/share/SuperApp\n >>> site_data_dir(appname, appauthor)\n '/usr/local/share/SuperApp'\n >>> site_data_dir(appname, appauthor, multipath=True)\n '/usr/local/share/SuperApp:/usr/share/SuperApp'\n >>> user_cache_dir(appname, appauthor)\n '/home/trentm/.cache/SuperApp'\n >>> user_log_dir(appname, appauthor)\n '/home/trentm/.cache/SuperApp/log'\n >>> user_config_dir(appname)\n '/home/trentm/.config/SuperApp'\n >>> site_config_dir(appname)\n '/etc/xdg/SuperApp'\n >>> os.environ['XDG_CONFIG_DIRS'] = '/etc:/usr/local/etc'\n >>> site_config_dir(appname, multipath=True)\n '/etc/SuperApp:/usr/local/etc/SuperApp'\n\n\n``AppDirs`` for convenience\n===========================\n\n::\n\n >>> from appdirs import AppDirs\n >>> dirs = AppDirs(\"SuperApp\", \"Acme\")\n >>> dirs.user_data_dir\n '/Users/trentm/Library/Application Support/SuperApp'\n >>> dirs.site_data_dir\n '/Library/Application Support/SuperApp'\n >>> dirs.user_cache_dir\n '/Users/trentm/Library/Caches/SuperApp'\n >>> dirs.user_log_dir\n '/Users/trentm/Library/Logs/SuperApp'\n\n\n\nPer-version isolation\n=====================\n\nIf you have multiple versions of your app in use that you want to be\nable to run side-by-side, then you may want version-isolation for these\ndirs::\n\n >>> from appdirs import AppDirs\n >>> dirs = AppDirs(\"SuperApp\", \"Acme\", version=\"1.0\")\n >>> dirs.user_data_dir\n '/Users/trentm/Library/Application Support/SuperApp/1.0'\n >>> dirs.site_data_dir\n '/Library/Application Support/SuperApp/1.0'\n >>> dirs.user_cache_dir\n '/Users/trentm/Library/Caches/SuperApp/1.0'\n >>> dirs.user_log_dir\n '/Users/trentm/Library/Logs/SuperApp/1.0'\n\n\n\nappdirs Changelog\n=================\n\nappdirs 1.4.3\n-------------\n- [PR #76] Python 3.6 invalid escape sequence deprecation fixes\n- Fix for Python 3.6 support\n\nappdirs 1.4.2\n-------------\n- [PR #84] Allow installing without setuptools\n- [PR #86] Fix string delimiters in setup.py description\n- Add Python 3.6 support\n\nappdirs 1.4.1\n-------------\n- [issue #38] Fix _winreg import on Windows Py3\n- [issue #55] Make appname optional\n\nappdirs 1.4.0\n-------------\n- [PR #42] AppAuthor is now optional on Windows\n- [issue 41] Support Jython on Windows, Mac, and Unix-like platforms. Windows\n support requires `JNA `_.\n- [PR #44] Fix incorrect behaviour of the site_config_dir method\n\nappdirs 1.3.0\n-------------\n- [Unix, issue 16] Conform to XDG standard, instead of breaking it for\n everybody\n- [Unix] Removes gratuitous case mangling of the case, since \\*nix-es are\n usually case sensitive, so mangling is not wise\n- [Unix] Fixes the utterly wrong behaviour in ``site_data_dir``, return result\n based on XDG_DATA_DIRS and make room for respecting the standard which\n specifies XDG_DATA_DIRS is a multiple-value variable\n- [Issue 6] Add ``*_config_dir`` which are distinct on nix-es, according to\n XDG specs; on Windows and Mac return the corresponding ``*_data_dir``\n\nappdirs 1.2.0\n-------------\n\n- [Unix] Put ``user_log_dir`` under the *cache* dir on Unix. Seems to be more\n typical.\n- [issue 9] Make ``unicode`` work on py3k.\n\nappdirs 1.1.0\n-------------\n\n- [issue 4] Add ``AppDirs.user_log_dir``.\n- [Unix, issue 2, issue 7] appdirs now conforms to `XDG base directory spec\n `_.\n- [Mac, issue 5] Fix ``site_data_dir()`` on Mac.\n- [Mac] Drop use of 'Carbon' module in favour of hardcoded paths; supports\n Python3 now.\n- [Windows] Append \"Cache\" to ``user_cache_dir`` on Windows by default. Use\n ``opinion=False`` option to disable this.\n- Add ``appdirs.AppDirs`` convenience class. Usage:\n\n >>> dirs = AppDirs(\"SuperApp\", \"Acme\", version=\"1.0\")\n >>> dirs.user_data_dir\n '/Users/trentm/Library/Application Support/SuperApp/1.0'\n\n- [Windows] Cherry-pick Komodo's change to downgrade paths to the Windows short\n paths if there are high bit chars.\n- [Linux] Change default ``user_cache_dir()`` on Linux to be singular, e.g.\n \"~/.superapp/cache\".\n- [Windows] Add ``roaming`` option to ``user_data_dir()`` (for use on Windows only)\n and change the default ``user_data_dir`` behaviour to use a *non*-roaming\n profile dir (``CSIDL_LOCAL_APPDATA`` instead of ``CSIDL_APPDATA``). Why? Because\n a large roaming profile can cause login speed issues. The \"only syncs on\n logout\" behaviour can cause surprises in appdata info.\n\n\nappdirs 1.0.1 (never released)\n------------------------------\n\nStarted this changelog 27 July 2010. Before that this module originated in the\n`Komodo `_ product as ``applib.py`` and then\nas `applib/location.py\n`_ (used by\n`PyPM `_ in `ActivePython\n`_). This is basically a fork of\napplib.py 1.0.1 and applib/location.py 1.0.1.\n\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/ActiveState/appdirs", "keywords": "application directory log cache user", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "appdirs", "package_url": "https://pypi.org/project/appdirs/", "platform": "", "project_url": "https://pypi.org/project/appdirs/", "project_urls": { "Homepage": "http://github.com/ActiveState/appdirs" }, "release_url": "https://pypi.org/project/appdirs/1.4.3/", "requires_dist": null, "requires_python": "", "summary": "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\".", "version": "1.4.3" }, "last_serial": 2688159, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "a1beb0530848580493678067e79bd7a3", "sha256": "93d276d378ecabe567a13a3a0d3a23b155dbb8a762a95acab75b2c111acb420b" }, "downloads": -1, "filename": "appdirs-1.1.0.zip", "has_sig": false, "md5_digest": "a1beb0530848580493678067e79bd7a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18380, "upload_time": "2010-09-02T19:16:27", "url": "https://files.pythonhosted.org/packages/c2/42/b4aaa41d488af6b265406ee90f15a30fe4f6fb5d53e0efda58e1f60e924b/appdirs-1.1.0.zip" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "7bc76ee16112388a390ca0139e565d9b", "sha256": "266036a5f1eb785a5eff2a362f552b7943dc7d83737a6a201f21276bd9ef234d" }, "downloads": -1, "filename": "appdirs-1.2.0.zip", "has_sig": false, "md5_digest": "7bc76ee16112388a390ca0139e565d9b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22478, "upload_time": "2011-01-26T23:03:11", "url": "https://files.pythonhosted.org/packages/20/09/566235d2020da488d0628d589df1492277fe3b4eb2aa775c00a4372bc30b/appdirs-1.2.0.zip" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "19d02a6e64227c529dac715400832f6e", "sha256": "6a5993513c9fdf0a64260cb17b032cb563064d88d9683bab091b4672c7f3cb97" }, "downloads": -1, "filename": "appdirs-1.3.0.tar.gz", "has_sig": false, "md5_digest": "19d02a6e64227c529dac715400832f6e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13680, "upload_time": "2014-04-21T23:46:40", "url": "https://files.pythonhosted.org/packages/b3/e5/f47dce7a8357c5ef995b8d580d1e2bd0ffa658810bb307989ec209587a3b/appdirs-1.3.0.tar.gz" } ], "1.4.0": [ { "comment_text": "", "digests": { "md5": "6157d8124b4274acb8beac8d2e4086aa", "sha256": "85e58578db8f29538f3109c11250c2a5514a2fcdc9890d9b2fe777eb55517736" }, "downloads": -1, "filename": "appdirs-1.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6157d8124b4274acb8beac8d2e4086aa", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11593, "upload_time": "2014-08-17T18:50:01", "url": "https://files.pythonhosted.org/packages/7b/8b/eebc6e2002a1e0383f1c7108d0111d4d33ea93bf417d7e19e43ec9b87b2b/appdirs-1.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1d17b4c9694ab84794e228f28dc3275b", "sha256": "8fc245efb4387a4e3e0ac8ebcc704582df7d72ff6a42a53f5600bbb18fdaadc5" }, "downloads": -1, "filename": "appdirs-1.4.0.tar.gz", "has_sig": false, "md5_digest": "1d17b4c9694ab84794e228f28dc3275b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14358, "upload_time": "2014-08-17T17:33:53", "url": "https://files.pythonhosted.org/packages/bd/66/0a7f48a0f3fb1d3a4072bceb5bbd78b1a6de4d801fb7135578e7c7b1f563/appdirs-1.4.0.tar.gz" } ], "1.4.1": [ { "comment_text": "", "digests": { "md5": "9b912c61f72c5c3b5fc42cb53e084ec8", "sha256": "566f148ff9f2e9a36912637a4ab1eaf708a499255d42a055c59dd0549507583d" }, "downloads": -1, "filename": "appdirs-1.4.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9b912c61f72c5c3b5fc42cb53e084ec8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11939, "upload_time": "2017-02-23T07:51:59", "url": "https://files.pythonhosted.org/packages/78/14/0b89ddf22e6466d4bb46c718b3f2fe3b2fb1060d0ce1094a06e4aa473a39/appdirs-1.4.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "557e52e411c814f43b0c3197b4b2fa7e", "sha256": "95259bccef631e5e44438c50087f761d699005e472f8f77f20ec968e51a7e10e" }, "downloads": -1, "filename": "appdirs-1.4.1.tar.gz", "has_sig": false, "md5_digest": "557e52e411c814f43b0c3197b4b2fa7e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11550, "upload_time": "2017-02-23T07:52:00", "url": "https://files.pythonhosted.org/packages/7c/26/b6b1222f79a56bc96a705eae343ec48fb3725c530c31af2133a3c4a33b2c/appdirs-1.4.1.tar.gz" } ], "1.4.2": [ { "comment_text": "", "digests": { "md5": "f718c16c331c6c5f5c50919e4a1f2572", "sha256": "a53330b9d53b66aba1e26907dea2958982ebad92735f9faf3897b73c909a20c1" }, "downloads": -1, "filename": "appdirs-1.4.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f718c16c331c6c5f5c50919e4a1f2572", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12074, "upload_time": "2017-02-24T08:27:58", "url": "https://files.pythonhosted.org/packages/ff/f8/7be9a3ff64bb18cb8f8fdcbd4bb4097903f2e4f930a337253f85325076c5/appdirs-1.4.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "30b6d92f3040fedc984d1cf8d8813abb", "sha256": "e2de7ae2b3be52542b711eacf4221683f1d2f7706a5550cb2c562ee4ba93ee74" }, "downloads": -1, "filename": "appdirs-1.4.2.tar.gz", "has_sig": false, "md5_digest": "30b6d92f3040fedc984d1cf8d8813abb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12600, "upload_time": "2017-02-24T08:28:00", "url": "https://files.pythonhosted.org/packages/88/99/293dac0b3cdf58ce029ec5393624fac5c6bde52f737f9775bd9ef608ec98/appdirs-1.4.2.tar.gz" } ], "1.4.3": [ { "comment_text": "", "digests": { "md5": "9ed4b51c9611775c3078b3831072e153", "sha256": "d8b24664561d0d34ddfaec54636d502d7cea6e29c3eaf68f3df6180863e2166e" }, "downloads": -1, "filename": "appdirs-1.4.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9ed4b51c9611775c3078b3831072e153", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12154, "upload_time": "2017-03-07T07:36:54", "url": "https://files.pythonhosted.org/packages/56/eb/810e700ed1349edde4cbdc1b2a21e28cdf115f9faf263f6bbf8447c1abf3/appdirs-1.4.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "44c679904082a2133f5566c8a0d3ab42", "sha256": "9e5896d1372858f8dd3344faf4e5014d21849c756c8d5701f78f8a103b372d92" }, "downloads": -1, "filename": "appdirs-1.4.3.tar.gz", "has_sig": false, "md5_digest": "44c679904082a2133f5566c8a0d3ab42", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12700, "upload_time": "2017-03-07T07:36:55", "url": "https://files.pythonhosted.org/packages/48/69/d87c60746b393309ca30761f8e2b49473d43450b150cb08f3c6df5c11be5/appdirs-1.4.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9ed4b51c9611775c3078b3831072e153", "sha256": "d8b24664561d0d34ddfaec54636d502d7cea6e29c3eaf68f3df6180863e2166e" }, "downloads": -1, "filename": "appdirs-1.4.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9ed4b51c9611775c3078b3831072e153", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12154, "upload_time": "2017-03-07T07:36:54", "url": "https://files.pythonhosted.org/packages/56/eb/810e700ed1349edde4cbdc1b2a21e28cdf115f9faf263f6bbf8447c1abf3/appdirs-1.4.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "44c679904082a2133f5566c8a0d3ab42", "sha256": "9e5896d1372858f8dd3344faf4e5014d21849c756c8d5701f78f8a103b372d92" }, "downloads": -1, "filename": "appdirs-1.4.3.tar.gz", "has_sig": false, "md5_digest": "44c679904082a2133f5566c8a0d3ab42", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12700, "upload_time": "2017-03-07T07:36:55", "url": "https://files.pythonhosted.org/packages/48/69/d87c60746b393309ca30761f8e2b49473d43450b150cb08f3c6df5c11be5/appdirs-1.4.3.tar.gz" } ] }