felipevolpone/ray

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Ray :saxophone:

Ray is a framework that let you deliver well-designed software without been stuck in a framework.

Ray is compatible with SQLAlchemy and Peewee!
Are you using Google App Engine? Great! Ray is compatible with it.

[![Build Status](https://travis-ci.org/felipevolpone/ray.svg?branch=master)](https://travis-ci.org/felipevolpone/ray)
[![Coverage Status](https://coveralls.io/repos/felipevolpone/ray/badge.svg?branch=master&service=github)](https://coveralls.io/github/felipevolpone/ray?branch=master)
[![PyPI version](https://badge.fury.io/py/ray_framework.svg)](https://badge.fury.io/py/ray_framework)

### Disclaimer
This is an *experimental* project! I wrote it because I would like to have the
experience of writing a framework. Ray helped me to think how to create better
abstractions, how to write code that other developers would use to write their
web apps and so on. Is also important to say that this project does not intend
to replace Django, Flask or Bottle. As I said I wrote it as a coding exercise.
With all that said, you're welcome to contribute to it if you want to have the
same experience, but you are also aware that this project may not be
production-ready.

## Features

* Creating an API has never been so easy
* Actions in APIs
* Database Hooks
* Authentication
* API protection
* Integration with Peewee
* Integration with SQLAlchemy
* Integration with Google App Engine


## How to start

Ray has a great documentation, [you can check it here](https://rayframework.github.io/site/) including a well documented [getting started guide](https://rayframework.github.io/site/getting_started/).

### Contributing
To contribute, check the [Contributing Guider](https://github.com/felipevolpone/ray/blob/master/CONTRIBUTING.md).