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
|
.DEFAULT_GOAL := help
# You can set these variables from the command line, and also from the environment for the first two.
SOURCEDIR = source
BUILDDIR = build
MAKE = make
VERSION = $(shell cat VERSION)
PACKAGE_NAME = sse-starlette
app_root := $(if $(PROJ_DIR),$(PROJ_DIR),$(CURDIR))
pkg_src = $(app_root)/sse_starlette
tests_src = $(app_root)/tests
.PHONY: all
all: clean build publish ## Build and publish
@echo "--------------------------------------------------------------------------------"
@echo "-M- building and distributing"
@echo "--------------------------------------------------------------------------------"
################################################################################
# Development \
DEVELOP: ## ############################################################
build-docker: ## build docker image
@echo "building docker image"
docker build --platform linux/amd64 --progress=plain -t sse_starlette .
#docker tag $(IMAGE_NAME) 339712820866.dkr.ecr.eu-central-1.amazonaws.com/sse-starlette/sse-starlette:latest
################################################################################
# Building, Deploying \
BUILDING: ## ############################################################
.PHONY: build
build: clean format ## format and build
@echo "building"
python -m build
.PHONY: publish
publish: ## publish
@echo "upload to Pypi"
twine upload --verbose dist/*
.PHONY: bump-major
bump-major: check-github-token ## bump-major, tag and push
bump-my-version bump --commit --tag major
git push
git push --tags
@$(MAKE) create-release
.PHONY: bump-minor
bump-minor: check-github-token ## bump-minor, tag and push
bump-my-version bump --commit --tag minor
git push
git push --tags
@$(MAKE) create-release
.PHONY: bump-patch
bump-patch: check-github-token ## bump-patch, tag and push
bump-my-version bump --commit --tag patch
git push
git push --tags
@$(MAKE) create-release
.PHONY: create-release
create-release: check-github-token ## create a release on GitHub via the gh cli
@if ! command -v gh &>/dev/null; then \
echo "You do not have the GitHub CLI (gh) installed. Please create the release manually."; \
exit 1; \
else \
echo "Creating GitHub release for v$(VERSION)"; \
gh release create "v$(VERSION)" --generate-notes; \
fi
.PHONY: check-github-token
check-github-token: ## Check if GITHUB_TOKEN is set
@if [ -z "$$GITHUB_TOKEN" ]; then \
echo "GITHUB_TOKEN is not set. Please export your GitHub token before running this command."; \
exit 1; \
fi
@echo "GITHUB_TOKEN is set"
################################################################################
# Testing \
TESTING: ## ############################################################
.PHONY: test
test: test-unit test-docker ## run tests
#python -m pytest -ra --junitxml=report.xml --cov-config=pyproject.toml --cov-report=xml --cov-report term --cov=$(pkg_src) tests/
#RUN_ENV=local python -m pytest -m "not (experimentation)" --cov-config=pyproject.toml --cov-report=html --cov-report=term --cov=$(pkg_src) tests
:
.PHONY: test-unit
test-unit: ## run all tests except "integration" marked
RUN_ENV=local python -m pytest -m "not (integration or experimentation)" --cov-config=pyproject.toml --cov-report=html --cov-report=term --cov=$(pkg_src) tests
.PHONY: test-docker
test-docker: ## test-docker (docker desktop: advanced settings)
@if [ -S /var/run/docker.sock > /dev/null 2>&1 ]; then \
echo "Running docker tests because /var/run/docker.docker exists..."; \
RUN_ENV=local python -m pytest -m "integration" tests; \
else \
echo "Skipping tests: /var/run/docker.sock does not exist."; \
fi
################################################################################
# Code Quality \
QUALITY: ## ############################################################
.PHONY: format
format: ## perform ruff formatting
@ruff format $(pkg_src) $(tests_src)
.PHONY: format-check
format-check: ## perform black formatting
@ruff format --check $(pkg_src) $(tests_src)
.PHONY: style
style: sort-imports format ## perform code style format
.PHONY: lint
lint: ## check style with ruff
ruff check $(pkg_src) $(tests_src)
.PHONY: mypy
mypy: ## check type hint annotations
@mypy --config-file pyproject.toml --install-types --non-interactive $(pkg_src)
################################################################################
# Clean \
CLEAN: ## ############################################################
.PHONY: clean
clean: clean-build clean-pyc ## remove all build, test, coverage and Python artifacts
.PHONY: clean-build
clean-build: ## remove build artifacts
rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . \( -path ./env -o -path ./venv -o -path ./.env -o -path ./.venv \) -prune -o -name '*.egg-info' -exec rm -fr {} +
find . \( -path ./env -o -path ./venv -o -path ./.env -o -path ./.venv \) -prune -o -name '*.egg' -exec rm -f {} +
.PHONY: clean-pyc
clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
################################################################################
# Misc \
MISC: ## ############################################################
define PRINT_HELP_PYSCRIPT
import re, sys
for line in sys.stdin:
match = re.match(r'^([a-zA-Z0-9_-]+):.*?## (.*)$$', line)
if match:
target, help = match.groups()
print("\033[36m%-20s\033[0m %s" % (target, help))
endef
export PRINT_HELP_PYSCRIPT
.PHONY: help
help:
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
|
