Update README.md
[cached-property.git] / Makefile
1 .PHONY: clean-pyc clean-build docs clean
2
3 help:
4 @echo "clean-build - remove build artifacts"
5 @echo "clean-pyc - remove Python file artifacts"
6 @echo "lint - check style with flake8"
7 @echo "test - run tests quickly with the default Python"
8 @echo "test-all - run tests on every Python version with tox"
9 @echo "coverage - check code coverage quickly with the default Python"
10 @echo "docs - generate Sphinx HTML documentation, including API docs"
11 @echo "release - package and upload a release"
12 @echo "dist - package"
13
14 clean: clean-build clean-pyc
15 rm -fr htmlcov/
16
17 clean-build:
18 rm -fr build/
19 rm -fr dist/
20 rm -fr *.egg-info
21
22 clean-pyc:
23 find . -name '*.pyc' -exec rm -f {} +
24 find . -name '*.pyo' -exec rm -f {} +
25 find . -name '*~' -exec rm -f {} +
26
27 lint:
28 flake8 cached_property.py tests
29
30 test:
31 py.test
32
33 test-all:
34 tox
35
36 coverage:
37 py.test --cov cached_property
38 coverage report -m
39 coverage html
40 open htmlcov/index.html
41
42 docs:
43 rm -f docs/cached-property.rst
44 rm -f docs/modules.rst
45 sphinx-apidoc -o docs/ cached-property
46 $(MAKE) -C docs clean
47 $(MAKE) -C docs html
48 open docs/_build/html/index.html
49
50 release: clean
51 python setup.py sdist upload
52 python setup.py bdist_wheel upload
53
54 dist: clean
55 python setup.py sdist
56 python setup.py bdist_wheel
57 ls -l dist