Makefile
.PHONY: clean clean-test clean-pyc clean-build docs help
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
define PRINT_HELP_PYSCRIPT
import re, sys
for line in sys.stdin:
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
if match:
target, help = match.groups()
print("%-20s %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . \( -path ./env -o -path ./venv -o -path ./.env -o -path ./.venv \) -prune -o -name '*.egg-info' -exec rm -fr {} +
find . \( -path ./env -o -path ./venv -o -path ./.env -o -path ./.venv \) -prune -o -name '*.egg' -exec rm -f {} +
clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
clean-test: ## remove test and coverage artifacts
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
rm -fr .pytest_cache
lint: ## check style with flake8
flake8 altair_recipes tests
test: ## run tests quickly with the default Python
poetry run py.test --cov=altair_recipes/
test-reset: ## reset regression tests and run them
echo Visually check test outputs after a reset for tests that were failing before the reset.
poetry run py.test --cov=altair_recipes/ --regtest-reset
test-all: ## run tests on every Python version with tox
tox
coverage: ## check code coverage quickly with the default Python
poetry run coverage run --source altair_recipes -m pytest
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html
%.html : %.py
poetry run pweave -i script -f html $<
TESTS=$(wildcard tests/*.py)
PWEAVE_DOCS = $(TESTS:py=html)
docs: $(PWEAVE_DOCS) ## generate Sphinx HTML documentation, including API docs
rm -f docs/altair_recipes.rst
rm -f docs/modules.rst
cp $(PWEAVE_DOCS) docs
poetry run sphinx-apidoc -o docs/ --maxdepth 0 altair_recipes/ altair_recipes/[a-z]*py
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
release: dist ## package and upload a release
poetry publish
dist: clean ## builds source and wheel package
poetry build
ls -l dist
install: clean ## install the package to the active Python's site-packages
poetry install --no-dev
install-dev: clean ## install dev with poetry
poetry install