103 lines
2.3 KiB
Makefile
103 lines
2.3 KiB
Makefile
.PHONY: help test test-coverage install docker-test black fix-import beautify
|
|
|
|
.DEFAULT: help
|
|
|
|
help:
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@echo "test"
|
|
@echo " Run Sanic Unit Tests"
|
|
@echo "test-coverage"
|
|
@echo " Run Sanic Unit Tests with Coverage"
|
|
@echo "install"
|
|
@echo " Install Sanic"
|
|
@echo "docker-test"
|
|
@echo " Run Sanic Unit Tests using Docker"
|
|
@echo "black"
|
|
@echo " Analyze and fix linting issues using Black"
|
|
@echo "fix-import"
|
|
@echo " Analyze and fix import order using isort"
|
|
@echo "beautify [sort_imports=1] [include_tests=1]"
|
|
@echo " Analyze and fix linting issue using black and optionally fix import sort using isort"
|
|
@echo ""
|
|
@echo "docs"
|
|
@echo " Generate Sanic documentation"
|
|
@echo ""
|
|
@echo "clean-docs"
|
|
@echo " Clean Sanic documentation"
|
|
@echo ""
|
|
@echo "docs-test"
|
|
@echo " Test Sanic Documentation for errors"
|
|
@echo ""
|
|
@echo "changelog"
|
|
@echo " Generate changelog for Sanic to prepare for new release"
|
|
@echo ""
|
|
@echo "release"
|
|
@echo " Prepare Sanic for a new changes by version bump and changelog"
|
|
@echo ""
|
|
|
|
|
|
clean:
|
|
find . ! -path "./.eggs/*" -name "*.pyc" -exec rm {} \;
|
|
find . ! -path "./.eggs/*" -name "*.pyo" -exec rm {} \;
|
|
find . ! -path "./.eggs/*" -name ".coverage" -exec rm {} \;
|
|
rm -rf build/* > /dev/null 2>&1
|
|
rm -rf dist/* > /dev/null 2>&1
|
|
|
|
test: clean
|
|
python setup.py test
|
|
|
|
test-coverage: clean
|
|
python setup.py test --pytest-args="--cov sanic --cov-report term --cov-append "
|
|
|
|
view-coverage:
|
|
sanic ./coverage --simple
|
|
|
|
install:
|
|
python setup.py install
|
|
|
|
docker-test: clean
|
|
docker build -t sanic/test-image -f docker/Dockerfile .
|
|
docker run -t sanic/test-image tox
|
|
|
|
beautify: black
|
|
ifdef sort_imports
|
|
ifdef include_tests
|
|
$(warning It is suggested that you do not run sort import on tests)
|
|
isort -rc sanic tests
|
|
else
|
|
$(info Sorting Imports)
|
|
isort -rc sanic tests
|
|
endif
|
|
endif
|
|
|
|
black:
|
|
black sanic tests
|
|
|
|
isort:
|
|
isort sanic tests
|
|
|
|
pretty: black isort
|
|
|
|
docs-clean:
|
|
cd docs && make clean
|
|
|
|
docs: docs-clean
|
|
cd docs && make html
|
|
|
|
docs-test: docs-clean
|
|
cd docs && make dummy
|
|
|
|
docs-serve:
|
|
sphinx-autobuild docs docs/_build/html --port 9999 --watch ./
|
|
|
|
changelog:
|
|
python scripts/changelog.py
|
|
|
|
release:
|
|
ifdef version
|
|
python scripts/release.py --release-version ${version} --generate-changelog
|
|
else
|
|
python scripts/release.py --generate-changelog
|
|
endif
|
|
|