FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-template/Makefile at main · python-project-templates/python-template · GitHub
python-project-templates
python-template
Repository navigation
Code
Issues
Pull requests
Actions
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
python-template
/
Makefile
Copy path
More file actions
More file actions
Latest commit
History
History
History
127 lines (91 loc) · 2.92 KB
Breadcrumbs
python-template
/
Makefile
Copy path
File metadata and controls
127 lines (91 loc) · 2.92 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
#
########
#
BUILD #
#
########
.PHONY
: develop build install
develop
:
#
# install dependencies and build library
uv pip install -e .[develop]
requirements
:
#
# install prerequisite python build requirements
uv pip install -r pyproject.toml --extra develop
build
:
#
# build the python library
python -m build -n
install
:
#
# install library
uv pip install
.
#
########
#
LINTS #
#
########
.PHONY
: lint-py lint-docs fix-py fix-docs lint lints fix format
lint-py
:
#
# lint python with ruff
python -m ruff check python_template
python -m ruff format --check python_template
lint-docs
:
#
# lint docs with mdformat and codespell
python -m mdformat --check README.md docs/wiki/
python -m codespell_lib README.md docs/wiki/
fix-py
:
#
# autoformat python code with ruff
python -m ruff check --fix python_template
python -m ruff format python_template
fix-docs
:
#
# autoformat docs with mdformat and codespell
python -m mdformat README.md docs/wiki/
python -m codespell_lib --write README.md docs/wiki/
lint
: lint-py lint-docs
#
# run all linters
lints
: lint
fix
: fix-py fix-docs
#
# run all autoformatters
format
: fix
#
###############
#
Other Checks #
#
###############
.PHONY
: check-dist check-types checks check
check-dist
:
#
# check python sdist and wheel with check-dist
check-dist -v
check-types
:
#
# check python types with ty
ty check --python
$$(
which python
)
checks
: check-dist
#
Alias
check
: checks
#
########
#
TESTS #
#
########
.PHONY
: test coverage tests
test
:
#
# run python tests
python -m pytest -v python_template/tests
coverage
:
#
# run tests and collect test coverage
python -m pytest -v python_template/tests --cov=python_template --cov-report term-missing --cov-report xml
#
Alias
tests
: test
#
##########
#
VERSION #
#
##########
.PHONY
: show-version patch minor major
show-version
:
#
# show current library version
@bump-my-version show current_version
patch
:
#
# bump a patch version
@bump-my-version bump patch
minor
:
#
# bump a minor version
@bump-my-version bump minor
major
:
#
# bump a major version
@bump-my-version bump major
#
#######
#
DIST #
#
#######
.PHONY
: dist dist-build dist-sdist dist-local-wheel publish
dist-build
:
#
build python dists
python -m build -w -s
dist-check
:
#
# run python dist checker with twine
python -m twine check dist/
*
dist
: clean dist-build dist-check
#
# build all dists
publish
: dist
#
# publish python assets
#
########
#
CLEAN #
#
########
.PHONY
: deep-clean clean
deep-clean
:
#
# clean everything from the repository
git clean -fdx
clean
:
#
# clean the repository
rm -rf .coverage coverage cover htmlcov logs build dist
*
.egg-info
#
###########################################################################################
.PHONY
: help
#
Thanks to Francoise at marmelab.com for this
.DEFAULT_GOAL
:= help
help
:
@grep -E
'
^[a-zA-Z_-]+:.*?## .*$$
'
$(
MAKEFILE_LIST
)
|
sort
|
awk
'
BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}
'
print-
%
:
@echo
'
$*=$($*)
'
Back
|
FazBrowse Home
|
New Git URL