Cob

What is Cob?

Everyone knows how to build a web application in theory. Most resources and tutorials go as far as a basic “hello world” webapp, and leave many details up for the developer to find out. Almost all serious webapps need to take care of deployment, configuration, background tasks, DB models/connections/migrations, static files location and configuration, and much much more.

Cob is a framework for building a solid scaffold for your webapps, and takes care of intertwining the various parts of a robust webapp for you. It also tries to leave as much of the glue code as possible inside Cob itself, so you can avoid as much boilerplate code in your own project as possible.

The core webapp backend part of Cob is based on Flask, but other features are flexible and can be easily tailored to any specific needs.

Cob is relatively opinionated about how projects should be structured, and provides utilities for generating the various components out of well-known templates.

Cob is greatly inspired by Ember CLI, which also aimed at solving a similar problem.

Contents:

• Getting Started
  • First Steps
    • Prerequisites
    • Installing Cob
    • Creating your Project
    • Creating a Simple Backend
    • Running the Test Server
    • Interlude – What Have We Just Created?
  • Working with Data
    • Adding Models
    • Initializing Migrations
    • Using Models in our Backend API
  • Testing
  • Adding Third-Party Components
  • Building a UI
    • Setting Up
    • Writing our Front-end Logic
    • Developing Front-end and Backend Simultaneously
  • Deploying your Application
    • Building your Application Image
    • Running your Application in Deployment
• Basic Grains
  • Views Grains
  • Blueprint Grains
  • Template Grains
  • Tasks Grains
  • Bundle Grains
• Working with Static Files
  • Static Grains
• Working with Databases
  • Models Grains
  • Controlling the Database URI
  • Database Initialization
• Using Migrations
  • Initializing the Migrations Directory
  • Create a Revision
  • Upgrade/Downgrade
• Background Tasks
  • Defining Tasks
  • Triggering Tasks
  • Requiring Application Context
  • Configuring Celery
    • Queue Names
    • Adding Worker Arguments
• Working with Front-end Code
  • Front-end Grains
    • Ember
  • Developing with Front-end Compilation
  • Working with Custom Node Versions
• Services
  • Redis
• Testing
  • Undockerized Testing
  • Dockerized Testing
• Using Hooks
  • Configuring your Flask App After Creation
• Project Configuration
  • Project Config
  • Cob Config Options
  • Managing Dependencies
  • Flask Config
  • Configuration Loading and Overrides
  • Deployment Configuration
    • Gunicorn Options
    • Exposed Ports
• Deployment
  • Deployment Requirements
    • Python Version
    • Docker and Docker-Compose
  • Building a Docker Image
  • Testing Dockerized Apps
  • Tagging and Pushing Images
  • Deploying on Systemd-based Systems
• Developing Cob Apps
  • Using Cob inside Virtual Environments
  • cob develop
• The Cob Environment
  • Virtualenv and Dependencies
  • Additional Dependencies
  • Environment Variables
• API Reference
  • Testing
• Cob Commands
• Changelog

Indices and tables

• Index
• Module Index
• Search Page