1Installation 2============ 3 4Requirements 5------------ 6 7afew works with python 3.6+, and requires notmuch and its python bindings. 8On Debian/Ubuntu systems you can install these by doing: 9 10.. code-block:: sh 11 12 $ sudo aptitude install notmuch python-notmuch python-dev python-setuptools 13 14Note: if you are installing `notmuch` using Homebrew on macOS, make sure 15to run ``$ brew install --with-python3 notmuch``, because the brew formula 16doesn't install python3 notmuch bindings by default. 17 18Unprivileged Install 19-------------------- 20 21It is recommended to install `afew` itself inside a virtualenv as an unprivileged 22user, either via checking out the source code and installing via setup.py, or 23via pip. 24 25.. code:: bash 26 27 # create and activate virtualenv 28 $ python -m venv --system-site-packages .venv 29 $ source .venv/bin/activate 30 31 # install via pip from PyPI: 32 $ pip install afew 33 34 # or install from source: 35 $ python setup.py install --prefix=~/.local 36 37 38You might want to symlink `.venv/bin/afew` somewhere inside your path 39(~/bin/ in this case): 40 41.. code:: bash 42 43 $ ln -snr .venv/bin/afew ~/.bin/afew 44 45Building documentation 46---------------------- 47 48Documentation can be built in various formats using Sphinx: 49 50.. code:: bash 51 52 # build docs into build/sphinx/{html,man} 53 $ python setup.py build_sphinx -b html,man 54