aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 533ade883b6aee103e73cba8e853944c68ad4043 (plain) (blame)
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
Hatter
======

Hatter is continuous integration server. It provides isolated execution
environments, for running automated actions, as virtual machines managed by
libvirt.

Key features:

    * automated projects based on git repositories
    * virtual machines as execution runners
    * virtual machine snapshots for consistent execution environments
    * per project configuration as YAML file inside project's repository
    * web based control and monitoring interface


Runtime requirements
--------------------

* python >=3.6

Additional required python packages are listed in `requirements.pip.txt`.


Development requirements
------------------------

* nodejs >=7
* yarn


Documentation
-------------

Online documentation available at `http://hatter.readthedocs.io`.


Build
-----

Build tool used for Hatter is pydoit (`http://pydoit.org/`). It can be
installed together with other python dependencies by running::

    $ pip install -r requirements.pip.txt

For listing available doit tasks, use::

    $ doit list

Default task::

    $ doit

creates `dist` folder containing Hatter distribution.


TODO
----

* web server - backend

    * orchestrate automation executor
    * JSON Schema describing messages used in communication between backend and
      frontend
    * implement functionality provided by internal communication protocol

* user interface - frontend

    * implement communication with backend
    * create user interface

* other

    * documentation
    * write complete setup.py
    * distribution