summaryrefslogtreecommitdiff
path: root/README
blob: 187cbfea5f4f89d78db3daa277cf5fa3165947da (plain)
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
README for ick API
==================

Ick API is a RESTful HTTP API/facade for [ick][] frontend(s).

[ick]: https://ick.liw.fi/

Dependencies
------------

Ick API is written in Python 3.5 and depends on following tools and libraries:

* [aiohttp][]
* [Gunicorn][]
* [make][]
* [pycodestyle][]
* [pydocstyle][]
* [pylint][]
* [pytest][]

[aiohttp]: http://aiohttp.readthedocs.io/
[Gunicorn]: http://gunicorn.org/
[make]: https://www.gnu.org/software/make/
[pycodestyle]: http://pycodestyle.pycqa.org/
[pydocstyle]: http://www.pydocstyle.org/
[pylint]: https://www.pylint.org/
[pytest]: https://www.pytest.org/

Usage
-----

FIXME

Development
-----------

FIXME

Releasing
---------

FIXME

Deployment
----------

FIXME

License
-------

Ick API in its entirety is copyright by its authors, and released under
the GNU Affero General Public Licence, version 3, or later.

    Ick API, a RESTful HTTP API/facade for Ick CI frontends
    Copyright (C) 2019  Ivan Dolgov, Pyry Heiskanen

    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/>.