Introduction

The project provides a REST interface to sms-page dynamodb tables. It is part of the larger sms-page project.

It is designed to be deployed to an AWS Lambda instance using zappa.

Installation

Zappa requires the use of Python 3.6 and a virtual environment.

On a Debian system this can be achieved with the python3.6 package.

$ python3.6 -m venv env
$ source env/bin/activate
(env) $ pip3.6 -rrequirements.txt
(env) $ zappa init
(env) $ vim zappa_settings.json
(env) $ zappa deploy prod

zappa_settings.json must be edited to set the environment_variables and ``extra_permissionsas shown inzappa_settings.example.json`.

API

• GET /rest/unit/:unit
• PUT /rest/unit/:unit
• GET /rest/unit/:unit/contacts
• GET /rest/unit/:unit/pagelog
• GET /rest/unit/:unit/members
• GET /rest/contact/:phone_number
• PUT /rest/contact/:phone_number
• GET /rest/member/:member_id
• PUT /rest/member/:member_id
• GET /rest/role/:name

LICENCE

The source code for this project is provided under the terms of the GNU Affero General Public License Version 3 (AGPL-3). A copy of this licence is provided in LICENCE.md.

This project relies on several libraries including several distributed under LGPL licences. Details can be found in NOTICE.md.