Installation and configuration¶
For all methods, Python 3 is required.
Note
The current version of tabulate from PyPi does not support double-width characters, leading to ugly table formatting. You can install tabulate from the source, or install Animanager’s development dependencies (see requirements).
From PyPi¶
Animanager can be installed fairly easily using from PyPi using pip:
$ pip3 install animanager
You may want to or need to install Animanager for the current user only:
$ pip3 install --user animanager
This requires pip for Python 3.
Setuptools¶
Animanager can also be installed from the source:
$ make install
This is equivalent to:
$ python3 setup.py install
You can also supply extra flags:
$ make INSTALL_FLAGS=--user install
This requires setuptools for Python 3. You can also install Animanager’s development dependencies, which includes setuptools, when building from source (see requirements).
Warning
Do not use development versions of Animanager except for testing! They may contain database migrations that are not stable or final. If you use them with your real database, it may leave it in an inconsistent state. Stick to versioned releases for regular use.
It is possible to use development versions if there are no problematic migrations, but you should know what you are doing and back up your database.
Development dependencies¶
You can install the development dependencies via a make shortcut:
$ make requirements
This is equivalent to:
$ pip3 install -r requirements.txt
Again, you can supply extra flags:
$ make INSTALL_FLAGS=--user requirements
Incidentally, this will also install setuptools, which is needed for installing Animanager from source.
This requires pip for Python 3.
Configuration¶
Animanager uses an INI configuration file. An example config.ini
is
supplied with the source distribution.
By default, Animanager looks for the configuration file at
~/.animanager/config.ini
. This can be changed with the --config
flag.