# Brink Framework
[](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/>.
Release files for brink 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| brink-0.3.0.tar.gz | 10.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| brink-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.5 kB
Release files / brink-0.3.0.tar.gz
| Download URL | brink-0.3.0.tar.gz |
|---|---|
| Size | 10.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a705453d73e0310ae76f2a6c21590e183249b280fdb5585890dd9a989ec7fb1
|
|
BLAKE2b-256 checksum How to use checksums |
329f92ad4654d135be2496e91f7c90aded755ecf0274af3e0f1e24e84919dcf1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / brink-0.3.0-py3-none-any.whl
| Download URL | brink-0.3.0-py3-none-any.whl |
|---|---|
| Size | 16.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ea72cddb826d845d6e40138a57affe9013e716ee13cb7b65e0acad983de9f09e
|
|
BLAKE2b-256 checksum How to use checksums |
8549af886557a2e73b8ac7b7664141ccf555cd547f925d4faad262b859e25509
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |