Installation
************
.. rubric:: dependencies
Alot depends on recent versions of notmuch and urwid. Note that due to restrictions
on argparse and subprocess, you need to run *python ≥ `2.7`*.
A full list of dependencies is below:
* `libmagic and python bindings `_, ≥ `5.04`:
* `configobj `_, ≥ `4.6.0`:
* `twisted `_, ≥ `10.2.0`:
* `libnotmuch `_ and it's python bindings, ≥ `0.12`.
* `urwid `_ toolkit, ≥ `1.0`
* `PyGPGME `_
On debian/ubuntu these are packaged as::
python-magic python-configobj python-twisted python-notmuch python-urwid python-gpgme
Alot uses `mailcap `_ to look up mime-handler for inline
rendering and opening of attachments. For a full description of the maicap protocol consider the
manpage :manpage:`mailcap(5)` or :rfc:`1524`. To avoid surprises you should at least have an inline
renderer (copiousoutput) set up for `text/html`, i.e. have something like this in your
:file:`~/.mailcap`::
text/html; w3m -dump -o document_charset=%{charset} '%s'; nametemplate=%s.html; copiousoutput
.. rubric:: get and install alot
Grab a `tarball here `_ or
directly check out a more recent version from `github `_.::
git clone git@github.com:pazz/alot.git
Run the :file:`setup.py` with the :option:`--user` flag to install locally::
python setup.py install --user
and make sure :file:`~/.local/bin` is in your :envvar:`PATH`.
For system-wide installation omit this falg and call with the respective permissions.
.. rubric:: generate manual and manpage
To generate the documentation you need `sphinx `_, ≥ `1.07` installed.
Go to :file:`docs/` and do a::
make html
make man
to generate the user manual and a man page. Both will end up in their respective subfolders in
:file:`docs/build`.