soran

table of contents

• Installation
  • Prerequisites
  • Dependencies
• Run server
• DB migration
• Documentation

Installation

Prerequisites

• flake8
• import-order
• click
• python3.4

Dependencies

• Install lint

  $ pip install -e .[extras]
  $ ln -s $(pwd)/hooks/pre-commit .git/hooks/pre-commit
  

• Install python libraries

  $ pip install . && pip install -e .[tests]
  

Run server

To configure your settings, copy exam.cfg.py.dist to exam.cfg.py.

$ cp exam.cfg.py.dist exam.cfg.py

And you can easily pass your configuration through -c option.

$ ./run.py -c exam.cfg.py serve

DB migration

To migrate your DB changes, create revision by revision command.

$ ./run.py -c exam.cfg.py revision -m "your message"

Or you can upgrade/downgrae your revision.

$ soran -c exam.cfg.py checkout head

With -@ option, you are able to use relative revision such as +1 , -1

$ soran -c exam.cfg.py checkout -@ +1

Documentation

Use Sphinx to create document for sourcodes, database models, API, and etc.