@@ -43,35 +43,38 @@ help: ## Display this help screen
43
43
@grep -E ' ^[\.a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST ) | sort | awk ' BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
44
44
45
45
.PHONY : all
46
- all : check test build check_package # # check code, test, build, check package
46
+ all : check test build check-package # # check code, test, build, check package
47
47
48
- .PHONY : install_dev
49
- install_dev : # # install all pip requirements and the package as editable
48
+ .PHONY : install-dev
49
+ install-dev : # # install all pip requirements and the package as editable
50
50
${PYTHON} -m pip install -r requirements/requirements-dev.lock.txt ${ARGS}
51
51
${PYTHON} -m pip install -e .
52
52
53
- .PHONY : install_ci
54
- install_ci : # # install all pip requirements needed for CI and the package as editable
53
+ .PHONY : install-ci
54
+ install-ci : # # install all pip requirements needed for CI and the package as editable
55
55
${PYTHON} -m pip install -r requirements/requirements-ci.lock.txt ${ARGS}
56
56
${PYTHON} -m pip install -e .
57
57
58
- .PHONY : install_test
59
- install_test : # # install all pip requirements needed for testing and the package as editable
58
+ .PHONY : install-test
59
+ install-test : # # install all pip requirements needed for testing and the package as editable
60
60
${PYTHON} -m pip install -r requirements/requirements-test.lock.txt ${ARGS}
61
61
${PYTHON} -m pip install -e .
62
62
63
- .PHONY : upgrade_requirements_lockfiles
64
- upgrade_requirements_lockfiles : # # upgrade pip requirements lock files
63
+ .PHONY : upgrade-requirements-lockfiles
64
+ upgrade-requirements-lockfiles : # # upgrade pip requirements lock files
65
65
${PIP_COMPILE} ${PIP_COMPILE_OPTS} setup.py requirements/requirements-base.in --output-file=requirements/requirements-base.lock.txt
66
66
${PIP_COMPILE} ${PIP_COMPILE_OPTS} requirements/requirements-base.lock.txt requirements/requirements-test.in --output-file=requirements/requirements-test.lock.txt
67
67
${PIP_COMPILE} ${PIP_COMPILE_OPTS} requirements/requirements-test.lock.txt requirements/requirements-ci.in --output-file=requirements/requirements-ci.lock.txt
68
68
${PIP_COMPILE} ${PIP_COMPILE_OPTS} requirements/requirements-ci.lock.txt requirements/requirements-dev.in --output-file=requirements/requirements-dev.lock.txt
69
69
70
- .PHONY : upgrade_dev
71
- upgrade_dev : upgrade_requirements_lockfiles install_dev # # upgrade all pip requirements and reinstall package as editable
70
+ .PHONY : upgrade-dev
71
+ upgrade-dev : upgrade-requirements-lockfiles install-dev # # upgrade all pip requirements and reinstall package as editable
72
72
73
- .PHONY : upgrade_test
74
- upgrade_test : upgrade_requirements_lockfiles install_test # # upgrade all pip requirements needed for testing and reinstall package as editable
73
+ .PHONY : upgrade-ci
74
+ upgrade-test : upgrade-requirements-lockfiles install-ci # # upgrade all pip requirements needed for CI and reinstall package as editable
75
+
76
+ .PHONY : upgrade-test
77
+ upgrade-test : upgrade-requirements-lockfiles install-test # # upgrade all pip requirements needed for testing and reinstall package as editable
75
78
76
79
.PHONY : test
77
80
test : # # run tests
@@ -94,49 +97,49 @@ pylint: ## run pylint
94
97
${PYLINT} ${PYLINT_OPTS} ${PACKAGE_DIR} ${DOCS_DIR} ./*.py ${ARGS}
95
98
${PYLINT} ${PYLINT_OPTS} --disable=duplicate-code --disable=redefined-outer-name --disable=too-many-arguments ${TESTS_DIR} ${ARGS}
96
99
97
- .PHONY : upload_package
98
- upload_package : build_package check_package # # upload the package to PyPI
100
+ .PHONY : upload-package
101
+ upload-package : build_package check_package # # upload the package to PyPI
99
102
${TWINE} upload ${DIST_DIR} /*
100
103
101
- .PHONY : check_package
102
- check_package : build_package # # check that the built package is well-formed
104
+ .PHONY : check-package
105
+ check-package : build_package # # check that the built package is well-formed
103
106
${TWINE} check ${DIST_DIR} /*
104
107
105
108
.PHONY : build
106
- build : build_package # # alias for build_package
109
+ build : build-package # # alias for build_package
107
110
108
- .PHONY : build_package
109
- build_package : # # build package (source + wheel)
111
+ .PHONY : build-package
112
+ build-package : # # build package (source + wheel)
110
113
-${RM} -r ${DIST_DIR}
111
114
${PYTHON} -m build
112
115
113
- .PHONY : bump_version_patch
114
- bump_version_patch : bump_version_check # # bump package version by the patch part
116
+ .PHONY : bump-version-patch
117
+ bump-version-patch : bump-version-check # # bump package version by the patch part
115
118
git add CHANGELOG.md
116
119
bump2version patch --allow-dirty
117
120
118
- .PHONY : bump_version_minor
119
- bump_version_minor : bump_version_check # # bump package version by the minor part
121
+ .PHONY : bump-version-minor
122
+ bump-version-minor : bump-version_-heck # # bump package version by the minor part
120
123
git add CHANGELOG.md
121
124
bump2version minor --allow-dirty
122
125
123
- .PHONY : bump_version_check
124
- bump_version_check :
126
+ .PHONY : bump-version-check
127
+ bump-version-check :
125
128
git diff --name-status
126
129
git diff-files --name-only | grep -q CHANGELOG.md
127
130
128
- .PHONY : build_docs
129
- build_docs : # # build documentation
131
+ .PHONY : build-docs
132
+ build-docs : # # build documentation
130
133
${SPHINXBUILD} ${SPHINXBUILD_OPTS} ${DOCS_SRC_DIR} ${DOCS_BUILD_DIR} /html ${ARGS}
131
134
132
- .PHONY : check_docs
133
- check_docs : # # check that the docs do not contain any warnings / errors
135
+ .PHONY : check-docs
136
+ check-docs : # # check that the docs do not contain any warnings / errors
134
137
${SPHINXBUILD} ${SPHINXBUILD_OPTS} ${DOCS_SRC_DIR} ${DOCS_BUILD_DIR} /html -w ${SPHINXBUILD_WARNING_LOG} ${ARGS}
135
138
${CAT} ${SPHINXBUILD_WARNING_LOG}
136
139
@${SHELL} -c ' [ ! -s ${SPHINXBUILD_WARNING_LOG} ]'
137
140
138
- .PHONY : watch_docs
139
- watch_docs : # # build documentation in watch mode (will start additonal http server)
141
+ .PHONY : watch-docs
142
+ watch-docs : # # build documentation in watch mode (will start additonal http server)
140
143
${SPHINXAUTOBUILD} ${SPHINXAUTOBUILD_OPTS} ${DOCS_SRC_DIR} ${DOCS_BUILD_DIR} /html ${ARGS}
141
144
142
145
.PHONY : clean
0 commit comments