Scrolliris Authorization API

Code Name: Bern

 , __
/|/  \
 | __/ _   ,_    _  _
 |   \|/  /  |  / |/ |
 |(__/|__/   |_/  |  |_/

Bern: BEaRer tokeN server for scrolliris

Repository

https://gitlab.com/scrolliris/scrolliris-authorization-api

Usage

See Dockerfile (Gentoo Linux).

% docker build -t scrolliris/authorization-api .
% docker run -it scrolliris/authorization-api

Development

Requirements

• Python 3.5.5
• Redis

Setup

: setup python environment (e.g. virtualenv)
% python3.5 -m venv venv
% source venv/bin/activate
(venv) % pip install --upgrade pip setuptools

Use waitress as wsgi server.
Check Makefile.

% cd /path/to/bern
% source venv/bin/activate

: set env
(venv) % cp .env.sample .env

: install packages
(venv) % ENV=development make setup

Boot

: run server (waitress)
(venv) % make serve

: run server (cherrypy)
(venv) % make start

Vet

• flake8
• flake8-docstrings (pep257)
• pylint

: add hook
(venv) % flake8 --install-hook git

(venv) % make check
(venv) % make lint

: run both
(venv) % make vet

Test

(venv) % make test

CI

You can check it by yourself using gitlab-ci-multi-runner on locale machine. It requires docker.

% ./tool/setup-gitlab-ci-multi-runner

: use script
% ./tool/ci-runner test

License

Scrolliris Authorization API
Copyright (c) 2018 Lupine Software LLC

AGPL-3.0

The project is distributed as GNU Affero General Public License. (version 3.0)

This 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 <https://www.gnu.org/licenses/>.

See LICENSE.