micro_flask_example

This is a sample flask app create with a atomist project template

Setting up the environment

This project depends on Python 2.7+ or 3.4+ and the Flask web framework.

Once you have installed Python for your environment, you should also setup a virtual environment with pip.

Then, you should install the dependencies required by the project as follows:

$ pip install -r requirements.txt

Getting started

Before you can run the application, the package must be found in your PYTHONPATH. To do so, run the next command once:

$ python setup.py develop

Run the application as follows:

$ python -m micro_flask_example --dev

then point your client at http://localhost:5000/.

Develop your application

Run tests

Tests are part of the project and should be continuously. Those tests are implemented using the py.test framework and located in the tests directories.

To execute them, run the following command:

$ pytest -v

Package & distribute your application

The project provides a recipe to build a Docker image of the application and its dependencies to simply its distribution. You can build the image as follows:

$ docker build -t micro_flask_example .

To run the application inside a container, execute then the following commands:

$ docker run -d -p 5000:5000 micro_flask_example