README


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

distixapi - an online API to a distix repository
=============================================================================

Introduction
-----------------------------------------------------------------------------

distix is a distributed ticketing system based on email and git.
distixapi is (or will be) an HTTP based RESTful API to a distix ticket
repository, on top of which an interactive web application for
reading, managing tickets can be built.


Hacking
-----------------------------------------------------------------------------

distix is written in Python 2 (do not ask for Python 3, it will happen
when it happens).

There are no unit tests yet.

There are some integration tests written for the controller's HTTP
API. To run them, run `./check`. You may add any command line
parameters than `yarn` accepts.


Legalese
-----------------------------------------------------------------------------

While distixapi itself is under the AGPL3+ license (see below), this
license does NOT apply to clients of the HTTP API it provides.

Copyright 2017  Lars Wirzenius

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.