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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
PYTHON_INTERPRETER=python3
VENV_PATH=.venv
PIP=$(VENV_PATH)/bin/pip
DJANGO_MANAGE=$(VENV_PATH)/bin/python ./manage.py
FLAKE=$(VENV_PATH)/bin/flake8
SPHINX_RELOAD=$(VENV_PATH)/bin/python ./docs/sphinx_reload.py
PYTEST=$(VENV_PATH)/bin/pytest
TOX=$(VENV_PATH)/bin/tox
TWINE=$(VENV_PATH)/bin/twine
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo
@echo " install -- to install this project with virtualenv and Pip"
@echo ""
@echo " clean -- to clean EVERYTHING"
@echo " clean-data -- to clean data (uploaded medias, database, etc..)"
@echo " clean-doc -- to remove documentation builds"
@echo " clean-install -- to clean installation"
@echo " clean-pycache -- to remove all __pycache__, this is recursive from current directory"
@echo ""
@echo " migrate -- to apply demo database migrations"
@echo " run -- to run Django development server for demo"
@echo " shell -- to run Django shell"
@echo " superuser -- to create a superuser for Django admin"
@echo
@echo " docs -- to build documentation"
@echo
@echo " flake -- to launch Flake8 checking"
@echo " test -- to launch test suite using Pytest"
@echo " test-initial -- to launch test suite using Pytest with re-initialized database"
@echo " tox -- to launch tests for every Tox environments"
@echo " quality -- to launch Flake8 checking and Pytest"
@echo
@echo " check-release -- to check package release before uploading it to PyPi"
@echo " release -- to release package for latest version on PyPi (once release has been pushed to repository)"
@echo
clean-pycache:
@echo ""
@echo "==== Clear Python cache ===="
@echo ""
rm -Rf .pytest_cache
find . -type d -name "__pycache__"|xargs rm -Rf
find . -name "*\.pyc"|xargs rm -f
.PHONY: clean-pycache
clean-install:
@echo ""
@echo "==== Clear installation ===="
@echo ""
rm -Rf $(VENV_PATH)
rm -Rf .tox
rm -Rf crispy_forms_foundation.egg-info
.PHONY: clean-install
clean-doc:
@echo ""
@echo "==== Clear documentation ===="
@echo ""
rm -Rf docs/_build
.PHONY: clean-doc
clean-data:
@echo ""
@echo "==== Clear sandbox data ===="
@echo ""
rm -Rf data
.PHONY: clean-data
clean: clean-doc clean-install clean-pycache clean-data
.PHONY: clean
venv:
@echo ""
@echo "==== Install virtual environment ===="
@echo ""
virtualenv -p $(PYTHON_INTERPRETER) $(VENV_PATH)
.PHONY: venv
migrate:
@echo ""
@echo "==== Apply pending migrations ===="
@echo ""
mkdir -p data/db
$(DJANGO_MANAGE) migrate
.PHONY: migrate
shell:
@echo ""
@echo "==== Running Django shell ===="
@echo ""
$(DJANGO_MANAGE) shell
.PHONY: shell
superuser:
@echo ""
@echo "==== Create new superuser ===="
@echo ""
$(DJANGO_MANAGE) createsuperuser
.PHONY: superuser
install: venv
@echo ""
@echo "==== Install everything for development ===="
@echo ""
mkdir -p data
$(PIP) install -e .[sandbox,dev,quality,doc,doc-live,release]
${MAKE} migrate
.PHONY: install
docs:
@echo ""
@echo "==== Build documentation ===="
@echo ""
cd docs && make html
.PHONY: docs
livedocs:
@echo ""
@echo "==== Watching documentation sources ===="
@echo ""
$(SPHINX_RELOAD)
.PHONY: livedocs
run:
@echo ""
@echo "==== Running development server ===="
@echo ""
$(DJANGO_MANAGE) runserver 0.0.0.0:8001
.PHONY: run
flake:
@echo ""
@echo "==== Flake ===="
@echo ""
$(FLAKE) --statistics --show-source crispy_forms_foundation tests
.PHONY: flake
test:
@echo ""
@echo "==== Tests ===="
@echo ""
$(PYTEST) -vv --reuse-db tests/
.PHONY: test
test-initial:
@echo ""
@echo "==== Tests from zero ===="
@echo ""
$(PYTEST) -vv --reuse-db --create-db tests/
.PHONY: test-initial
freeze-dependencies:
@echo ""
@echo "==== Freezing backend dependencies versions ===="
@echo ""
$(VENV_PATH)/bin/python freezer.py crispy-forms-foundation --destination=frozen.txt
.PHONY: freeze-dependencies
build-package:
@echo ""
@echo "==== Build package ===="
@echo ""
rm -Rf dist
$(VENV_PATH)/bin/python setup.py sdist
.PHONY: build-package
release: build-package
@echo ""
@echo "==== Release ===="
@echo ""
$(TWINE) upload dist/*
.PHONY: release
check-release: build-package
@echo ""
@echo "==== Check package ===="
@echo ""
$(TWINE) check dist/*
.PHONY: check-release
tox:
@echo ""
@echo "==== Launch all Tox environments ===="
@echo ""
$(TOX)
.PHONY: tox
quality: test flake docs check-release freeze-dependencies
@echo ""
@echo "♥ ♥ Everything should be fine ♥ ♥"
@echo ""
.PHONY: quality
|
