generator-weppy-mvc/app/templates/README.md

Build a full stack python web application in minutes.

[![Build Status][travis-img]][travis-url]
[![Coverage Status][coverall-img]][coverall-url]
[![Weppy Version](https://img.shields.io/badge/weppy-<%= weppyVersion %>-blue.svg)](https://github.com/gi0baro/weppy)


# <%= appTitle %>
 
A [Weppy](http://weppy.org) application.

<%= packageDescription %>

## Run

**Requirements**:
- Python <%= reqMajor %>.<%= reqMinor %>.<%= reqPatch %>+

For virtualenv setup and activation:

```
virtualenv --python=$(which python<%=reqMajor %>.<%= reqMinor %>) env
. ./env/bin/activate
pip install -r requirements.txt
python run.py
```

Otherwise:

```
pip install -r requirements.txt
python run.py
```

***If pip fails on ubuntu, try `sudo apt-get install libyaml-dev libyaml-python<%= reqMajor %>.<%= reqMinor %>-dev`**

### Docker

To make your application available at ```http://localhost/```:

```
docker build -t <%= appName %> .
docker run -it -p 80:8000 --rm --name <%= appName %> <%= appName %>
```


## Develop

Running in development mode will enable debug pages and
automatically create test users in multiple states.
Test users will be removed from the DB after stopping.

To start the app in development mode, do:

```
python run.py --dev
```

See ```<%= appName %>/cli.py``` for cli commands. 

## Test

```
py.test -v -s --cov-report term-missing --cov=<%= appName %> -r w tests
```


## License

[<%= license %>](LICENSE) <%= year %> <%= username %>


[travis-img]: https://travis-ci.org/<%= username %>/<%= appName %>.svg?branch=master
[travis-url]: https://travis-ci.org/<%= username %>/<%= appName %>
[coverall-img]: https://coveralls.io/repos/github/<%= username %>/<%= appName %>/badge.svg?branch=master
[coverall-url]: https://coveralls.io/github/<%= username %>/<%= appName %>?branch=master