File: Makefile

package info (click to toggle)
cookiecutter 1.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,328 kB
  • sloc: python: 4,126; makefile: 242; sh: 4
file content (97 lines) | stat: -rw-r--r-- 2,581 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.PHONY: clean-tox clean-pyc clean-build docs
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
BROWSER := python -c "$$BROWSER_PYSCRIPT"

help:
	@echo "clean-build - remove build artifacts"
	@echo "clean-pyc - remove Python file artifacts"
	@echo "clean-tox - remove tox testing 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 "sdist - package"
	@echo "submodules - pull and update git submodules recursively"

clean: clean-tox clean-build clean-pyc

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

clean-pyc:
	find . -type d -name '__pycache__' -exec rm -rf {} +
	find . -type f -name '*.py[co]' -exec rm -f {} +
	find . -name '*~' -exec rm -f {} +

clean-tox:
	rm -rf .tox/

lint:
	flake8 cookiecutter tests

test:
	tox -e py

test-all:
	tox


coverage:
	tox -e cov-report
	$(BROWSER) htmlcov/index.html

submodules:
	git pull --recurse-submodules
	git submodule update --init --recursive

docs:
	rm -f docs/cookiecutter.rst
	sphinx-apidoc -o docs/ cookiecutter
	rm -f docs/modules.rst
	$(MAKE) -C docs clean
	$(MAKE) -C docs html
	make contributing
	$(BROWSER) docs/_build/html/index.html

servedocs: docs
	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: clean
	python setup.py sdist bdist_wheel upload

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

wheel: clean
	python setup.py bdist_wheel
	ls -l dist
contributing:
	rm CONTRIBUTING.rst
	touch CONTRIBUTING.rst
	cat docs/contributing.rst >> CONTRIBUTING.rst
	echo "\r\r" >> CONTRIBUTING.rst
	cat docs/types_of_contributions.rst >> CONTRIBUTING.rst
	echo "\r\r" >> CONTRIBUTING.rst
	cat docs/contributor_setup.rst >> CONTRIBUTING.rst
	echo "\r\r" >> CONTRIBUTING.rst
	cat docs/contributor_guidelines.rst >> CONTRIBUTING.rst
	echo "\r\r" >> CONTRIBUTING.rst
	cat docs/contributor_testing.rst >> CONTRIBUTING.rst
	echo "\r\r" >> CONTRIBUTING.rst
	cat docs/core_committer_guide.rst >> CONTRIBUTING.rst
	echo "\r\rAutogenerated from the docs via \`make contributing\`" >> CONTRIBUTING.rst
	echo "WARNING: Don't forget to replace any :ref: statements with literal names"