Metadata-Version: 2.0
Name: brink
Version: 0.1.0
Summary: A simple real time web framework based on aiohttp and RethinkDB.
Home-page: https://github.com/lohmander/brink
Author: CH Lohmander
Author-email: hannes@lohmander.me
License: BSD-3
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: aiohttp
Requires-Dist: aiohttp-autoreload
Requires-Dist: aiorethink
Requires-Dist: cerberus
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

# Brink Framework

- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Tutorial](#tutorial)
    - [Start project](#start-project)
    - [Models](#models)
    - [Handlers](#handlers)
    - [Basic frontend](#basic-frontend)

## Introduction
TBD

## Getting started
TBD

## Tutorial
### Start project
TBD

### Models

```python
from brink import models


class Message(models.Model):

    schema = {
        "message": {"type": "string"},
        "sender": {"type": "string"}
    }
```

### Handlers

```python
async def handle_honks(request, ws):
    async for honk in Honk.changes().all():
        ws.send_json(honk)
```

### Basic frontend
TBD


