Makefile

.PHONY: clean-pyc clean-build clean-pyc clean-docs clean-coverage clean-tests docs clean

help:
	@echo "clean-build - remove build artifacts"
	@echo "clean-pyc - remove Python file artifacts"
	@echo "lint - check style with flake8"
	@echo "test - run tests quickly with the default Python"
	@echo "test-all - run tests on every Python version with tox"
	@echo "coverage - check code coverage quickly with the default Python"
	@echo "docs - generate Sphinx HTML documentation, including API docs"
	@echo "release - package and upload a release"
	@echo "dist - package"

clean: clean-build clean-pyc clean-docs clean-coverage clean-tests

clean-build:
	rm -fr build/
	rm -fr dist/
	rm -fr *.egg-info

clean-pyc:
	find . -type f -name "*.py[co]" -delete
	find . -type f -name '*~' -delete
	find . -type d -name "__pycache__" -delete

clean-docs:
	rm -f docs/gnsq.rst
	rm -f docs/gnsq.contrib.rst
	rm -f docs/gnsq.stream.rst
	rm -f docs/modules.rst
	$(MAKE) -C docs clean

clean-coverage:
	rm -f .coverage
	rm -fr htmlcov/

clean-tests:
	rm -fr .tox
	rm -fr .cache
	rm -fr .pytest_cache

lint:
	flake8 gnsq tests

test:
	pytest tests

test-fast:
	pytest tests --fast

test-all:
	tox

coverage:
	pytest --cov gnsq --cov-report html tests
	open htmlcov/index.html

docs: clean-docs
	sphinx-apidoc -o docs/ gnsq
	$(MAKE) -C docs html
	open docs/_build/html/index.html

release: dist
	twine check dist/*
	twine upload dist/*

dist: clean
	python setup.py sdist
	python setup.py bdist_wheel
	ls -l dist