Metadata-Version: 2.0
Name: brink
Version: 0.3.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.6
Requires-Dist: aiohttp
Requires-Dist: aiohttp-autoreload
Requires-Dist: inflection
Requires-Dist: pycolor
Requires-Dist: rethinkdb
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

# Brink Framework

[![Build Status](https://travis-ci.org/lohmander/brink.svg?branch=feature%2Fmodel-rewrite)](https://travis-ci.org/lohmander/brink)

## Installation

    $ pip install brink

## Getting started

Getting started is very easy assuming you have Docker installed.

Start RethinkDB like so

    $ docker run -p 8080:8080 -p 28015:28015 -d --name rethink rethinkdb

And then get started with your project like so

    $ brink start-project myproject
    $ cd myproject
    $ brink sync-db
    $ brink run

## Contributing

Get the sources

    $ git clone git@github.com:lohmander/brink.git

create a virtualenv

    $ virtualenv venv
    $ source venv/bin/activate

install Brink

    $ cd brink
    $ pip3 install -e .

start a new project and start working

    $ brink start-project testproj

That's it.

Now whenever you change the framework source code, it'll update in your project.

## Documentation

Full documentation is (will be) available at <https://brinkframework.github.io/brink/>.



