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
46
47
48
49
50
51
52
53
54

README for apifw
=============================================================================

`apifw` (API framework) is a little Python library for implementing
RESTful HTTP APIs. It is intended to be used with [gunicorn][] and
[bottle.py][]. The framework provides, on top of what Bottle provides,
logging, and authorization using [JSON Web Tokens][] signed with an
RSA key, as well as on-demand creation of routes.

The framework is meant for Python 3 only.

[gunicorn]: http://gunicorn.org/
[bottle.py]: http://bottlepy.org/docs/dev/
[JSON Web Tokens]: https://jwt.io/


To run tests
-----------------------------------------------------------------------------

Run the following command to run unit and integration tests:

    ./check

You will need [CoverageTestRunner][] and [yarn][].

[CoverageTestRunner]: https://liw.fi/coverage-test-runner/
[yarn]: https://liw.fi/cmdtest/


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

There is no documentation yet. See the `apitest.py` file for a working
example. The `apifw.yarn` test suite uses it, so see that for details
on how to run program using the framework.


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

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