diff options
| author | eddyp <eddy.petrisor+github.com@gmail.com> | 2013-03-19 00:23:48 +0200 |
|---|---|---|
| committer | eddyp <eddy.petrisor+github.com@gmail.com> | 2013-03-19 00:23:48 +0200 |
| commit | 9306c247abbb60f2fdce7242e6c15b2463788967 (patch) | |
| tree | 9bcf21de6726258111242749220ec684b42bfe8d /README.rst | |
| parent | 74326112bb613999b430893294d61dee35fa93ca (diff) | |
| download | appdirs-9306c247abbb60f2fdce7242e6c15b2463788967.tar.gz | |
Update README.rst to mention *_config_dir APIs
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -29,8 +29,10 @@ 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 donfig dir (``user_donfig_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: @@ -86,6 +88,13 @@ On Linux:: '/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, returnlist=True) + '/etc/SuperApp:/usr/local/etc/SuperApp' ``AppDirs`` for convenience |