DataBridgesKnots/Makefile at main · WFP-VAM/DataBridgesKnots · GitHub

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
#* Variables
SHELL := /usr/bin/env bash
PYTHON := python
PYTHONPATH := `pwd`/src

#* INSTALL

#* Install dependencies and package
.PHONY: install
install:
	uv sync --all-extras --dev --frozen

#* LINTING

#* Check formatting
.PHONY: check-codestyle
check-codestyle:
	uv run isort --diff --check-only --settings-path pyproject.toml ./
	uv run black --diff --check --config pyproject.toml ./
	uv run ruff check .

#* Fix formatting
.PHONY: codestyle
codestyle:
	uv run isort --settings-path pyproject.toml ./
	uv run black --config pyproject.toml ./
	uv run ruff check . --fix

#* Tests
.PHONY: test
test:
	uv run pytest -c pyproject.toml --cov-report=html --cov=data_bridges_knots tests/
	uv run coverage-badge -o assets/images/coverage.svg -f

#* Typing
.PHONY: mypy
mypy:
	uv run mypy --config-file pyproject.toml ./

# .PHONY: check-safety
# check-safety:
# 	uv run bandit -r src

#* All in one
.PHONY: lint
lint: test check-codestyle mypy

#* DOCS

#* Documentation
# Test
.PHONY: docs-test
docs-test:
	uv run python -m doctest data_bridges_knots/client.py

# Build documentation files into site folder
.PHONY: docs
docs:
	uv run mkdocs build

# Render documentation on localhost
.PHONY: docs-serve
docs-serve:
	uv run mkdocs serve


#* DOCKER

# Example: make docker-build VERSION=latest
# Example: make docker-build IMAGE=some_name VERSION=0.1.0
.PHONY: docker-build
docker-build:
	@echo Building docker $(IMAGE):$(VERSION) ...
	docker build \
		-t $(IMAGE):$(VERSION) . \
		-f ./docker/Dockerfile --no-cache

# Example: make docker-remove VERSION=latest
# Example: make docker-remove IMAGE=some_name VERSION=0.1.0
.PHONY: docker-remove
docker-remove:
	@echo Removing docker $(IMAGE):$(VERSION) ...
	docker rmi -f $(IMAGE):$(VERSION)


#* CLEANING

.PHONY: pycache-remove
pycache-remove:
	find . | grep -E "(__pycache__|\.pyc|\.pyo$$)" | xargs rm -rf

.PHONY: dsstore-remove
dsstore-remove:
	find . | grep -E ".DS_Store" | xargs rm -rf

.PHONY: mypycache-remove
mypycache-remove:
	find . | grep -E ".mypy_cache" | xargs rm -rf

.PHONY: ipynbcheckpoints-remove
ipynbcheckpoints-remove:
	find . | grep -E ".ipynb_checkpoints" | xargs rm -rf

.PHONY: pytestcache-remove
pytestcache-remove:
	find . | grep -E ".pytest_cache" | xargs rm -rf

.PHONY: build-remove
build-remove:
	rm -rf build/

.PHONY: cleanup
cleanup: pycache-remove dsstore-remove mypycache-remove ipynbcheckpoints-remove pytestcache-remove