/sanic_template

Primary LanguagePython

Sanic API Template

Development Server

./dev_srv.sh

Tests, Linting, Code Coverage

The main testing script is ./run_tests.sh.

It has further capabilities to give output on linting, code coverage reports, and a more verbose output.

  • In order to further speed up test development time, you can limit the output to be one or a set of modules:
    eg => ./run_tests.sh auth users will run the test suite for auth and users endpoints.

  • Add the following to the end of ./run_tests.sh to get further output:
    cov => code coverage
    lint => linting with flake8
    full => more verbose output for tests

An example running all is: ./run_tests.sh cov lint full

Atom Flake8 Linting

Install https://atom.io/packages/linter-flake8 Go into your atom config file from an option in the top menu.

Add:

"linter-flake8":
  executablePath: "$PROJECT/.venv/bin/flake8"

Utility scripts

upgrade_requirements.sh If new packages are added then run this script to add them using this script.
This script ALSO updates all existing packages.