Skip to content

mijdavis2/starter_weppy

Repository files navigation

Starter Weppy

Build Status Coverage Status Codacy Badge Weppy Version

Starter Weppy is a python web application starter kit built on the weppy framework. Current version is based on Weppy 0.8 with an MVC scaffolding. An api module, dev mode, and 100% test coverage are included out of the box.

Live demo: https://starter-weppy.com

Start a New Project:

Use the Starter Weppy yeoman generator: generator-weppy-mvc.

generator-weppy-mvc

NPM version Build Status Coverage percentage Codacy Badge

The definitive starter-weppy generator.

Run

Requirements:

  • Python 3.4 - 3.5+

For automated pip and virtual env setup and creation, clone this repository and in your terminal do:

. ./setup.sh
python run.py

Otherwise, do:

pip install -r requirements.txt
python run.py

Docker

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

docker build -t starter-weppy .
docker run -it -p 80:8000 --rm --name starter-weppy starter-weppy

Develop

Running in development mode will enable debug pages, automatically create test, users in multiple states, and upon killing the app, those test users will automatically be deleted from the DB.

To start the app in development mode, do:

python run.py --dev

See starter_weppy/cli.py for cli commands.

Test

Client testing:

py.test -v -s --cov-report term-missing --cov=starter_weppy -r w tests/client

Integration (selenium) testing:

./tests/selenium/run.sh

Caveats

  • The current setup.sh script is set to Python 3.5.2. Though I suggest upgrading to 3.5.2, you can replace PYTHON_VERSION with 3.4.3 in the script.

License

MIT © mijdavis2