tstest

Simple REST API based app in Flask.

Install

It is recommended to use the latest version of Python 3 and PyPy.

Clone the repository:

git clone https://github.com/gsorry/tstest.git
cd tstest

Python 3 comes bundled with the venv module to create virtual environments.

Create a virtual environment:

python3 -m venv venv

Before you work on your project, activate the corresponding environment:

. venv/bin/activate

Within the activated environment, use the following command to install Flask:

pip3 install -e .

Run (Development only)

Now you can run your application using the flask command. From the terminal, tell Flask where to find your application, then run it in development mode:

export FLASK_APP=tsapp
export FLASK_ENV=development
flask init-db
flask run

Open http://127.0.0.1:5000 in a browser.

When Flask starts, it uses a local instance folder. You can find it at project root with instance name.

Create the config.py file in the instance folder, which the factory will read from if it exists.

instance/config.py:

SECRET_KEY='dev'
SQLALCHEMY_ECHO = True
SQLALCHEMY_TRACK_MODIFICATIONS = False
SENDGRID_SENDER_EMAIL = '<SENDER_EMAIL_ADDRESS>'
SENDGRID_API_KEY = '<GENERATED_API_KEY>'

In order for the application to be able to send email messages, it is necessary to create a Sendgrid account and set up an API Key. Enter the API Key in the configuration. Restart application.

Test

pip3 install '.[test]'
pytest

Run with coverage report:

coverage run -m pytest
coverage report
coverage html  # open htmlcov/index.html in a browser

Build

Make sure the wheel library is installed first:

pip3 install wheel

Build a wheel distribution file:

python3 setup.py bdist_wheel

Deploy

You can find the file in dist/tsapp-1.0.0-pu2.py3-none-any.whl. The file name is the name of the project, the version, and some tags about the file can install.

Copy this file to another machine, set up a new virtualenv, then install the file with pip:

pip3 install --upgrade tsapp-1.0.0-py2.py3-none-any.whl

Pip will install your project along with its dependencies.

When Flask detects that it’s installed (not in editable mode), it uses a different directory for the instance folder. You can find it at venv/var/flaskr-instance instead.

Create the config.py file in the instance folder, which the factory will read from if it exists.

venv/var/tsapp-instance/config.py:

SECRET_KEY='<SOME_RANDOM_SECRET_KEY_STRING>'
SQLALCHEMY_ECHO = False
SQLALCHEMY_TRACK_MODIFICATIONS = True
SQLALCHEMY_DATABASE_URI = 'sqlite:///<PATH_TO_SQLITE_FILE>/tsapp.sqlite'
SENDGRID_SENDER_EMAIL = '<SENDER_EMAIL_ADDRESS>'
SENDGRID_API_KEY = '<GENERATED_API_KEY>'

In order for the application to be able to send email messages, it is necessary to create a Sendgrid account and set up an API Key. Enter the API Key in the configuration.

Run with a Production Server

When running publicly rather than in development, you should not use the built-in development server (flask run).

Instead, use a production WSGI server. For example, to use Waitress, first install it in the virtual environment:

pip3 install waitress

You need to tell Waitress about your application, but it doesn’t use FLASK_APP like flask run does. You need to tell it to import and call the application factory to get an application object.

waitress-serve --call 'tsapp:create_app'