Odin

The boostrapping for a Python REST API. Part of the Valhalla Project

The Odin Stack

Web Framework

• Falcon

Database

• Relational Database - MySQL with Peewee ORM
• NoSQL Database - MongoDB with PyMongo
• In-Memory Cache - Redis with redis-py

Cloud

• Amazon Web Services with Boto3

Payment Processing

• Stripe - Python API Docs

HTML Templating

• Jinja2

Asynchronous Tasking

• Celery

Installation

Dependencies

1. Docker

How to Install

1. Clone the repository, copy it, remove the original repo, and change to your new project

   git clone git@github.com:tgrant59/Odin.git
   cp -r Odin example-project-name
   rm -rf Odin
   cd Odin

Configure your installation

Your main configuration file is app/utils/config.py. You will change many of the configuration parameters here. Some recommended ones are outlined below. Remember that this is your development configuration file, so you shouldn't put production values here.

Set Your Database Names

• Set the names of your MySQL and MongoDB databases in the config file
• Change the MySQL initialization script (dev/init/init-mysql.sh) to use the correct MySQL database name

Configure Email Addresses

• Set the addresses in the Email config section
• Set the ADMINS and the SERVER_EMAIL in the CELERY config

Configure Stripe

• Set your Stripe test token
• Define your Stripe plans

Usage

Celery

• By default, Strappy comes configured to run 2 queues: the default 'celery' queue and a 'priority' queue. The mailing tasks are configured to run in the 'priority' queue.