summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2017-07-31 14:38:01 +0300
committerLars Wirzenius <liw@liw.fi>2017-07-31 14:38:01 +0300
commit88ab1558b35792349f64116a99e1796d40d2c9aa (patch)
treebde41bf2efc544728ecdc625e28e7de121afeca1 /README
downloadapifw-88ab1558b35792349f64116a99e1796d40d2c9aa.tar.gz
Add: initial commit
This version has already been seen working so it might work for you.
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0e98358
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+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/
+
+
+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/>.