1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
Installation
============
The most recent release can be installed from
`PyPI <https://pypi.org/project/pystow>`_ with:
.. code-block:: shell
$ pip install pystow
The most recent code and data can be installed directly from GitHub with:
.. code-block:: shell
$ pip install git+https://github.com/cthoyt/pystow.git
To install in development mode, use the following:
.. code-block:: shell
$ git clone git+https://github.com/cthoyt/pystow.git
$ cd pystow
$ pip install -e .
Configuration
=============
By default, data is stored in the ``$HOME/.data`` directory. By default, the ``<app>`` app will create the
``$HOME/.data/<app>`` folder.
If you want to use an alternate folder name to ``.data`` inside the home directory, you can set the ``PYSTOW_NAME``
environment variable. For example, if you set ``PYSTOW_NAME=mydata``, then the following code for the ``pykeen`` app
will create the ``$HOME/mydata/pykeen/`` directory:
.. code-block:: python
import os
import pystow
# Only for demonstration purposes. You should set environment
# variables either with your .bashrc or in the command line REPL.
os.environ['PYSTOW_NAME'] = 'mydata'
# Get a directory (as a pathlib.Path) for ~/mydata/pykeen
pykeen_directory = pystow.join('pykeen')
If you want to specify a completely custom directory that isn't relative to your home directory, you can set
the ``PYSTOW_HOME`` environment variable. For example, if you set ``PYSTOW_HOME=/usr/local/``, then the following code
for the ``pykeen`` app will create the ``/usr/local/pykeen/`` directory:
.. code-block:: python
import os
import pystow
# Only for demonstration purposes. You should set environment
# variables either with your .bashrc or in the command line REPL.
os.environ['PYSTOW_HOME'] = '/usr/local/'
# Get a directory (as a pathlib.Path) for /usr/local/pykeen
pykeen_directory = pystow.join('pykeen')
.. warning:: If you set ``PYSTOW_HOME``, then ``PYSTOW_NAME`` is disregarded.
X Desktop Group (XDG) Compatibility
-----------------------------------
While PyStow's main goal is to make application data less opaque and less
hidden, some users might want to use the
`XDG specifications <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_
for storing their app data.
If you set the environment variable ``PYSTOW_USE_APPDIRS`` to ``true`` or ``True``, then the
`appdirs <https://pypi.org/project/appdirs>`_ package will be used to choose
the base directory based on the ``user data dir`` option.
.. warning:: If you use this setting, make sure you first do ``pip install appdirs``
.. note:: This can still be overridden by ``PYSTOW_HOME``.
|
