validmind-library/Makefile at main · validmind/validmind-library · 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
	# https://stackoverflow.com/questions/10858261/how-to-abort-makefile-if-variable-not-set
check_defined = \
    $(strip $(foreach 1,$1, \
        $(call __check_defined,$1,$(strip $(value 2)))))
__check_defined = \
    $(if $(value $1),, \
      $(error Undefined $1$(if $2, ($2))))

format:
	poetry run black validmind
	poetry run isort validmind

lint:
# don't check max line length for now since black already takes care of it
# and flake8 is too strict where it doesn't need to be
	poetry run flake8 validmind --config .flake8

install:
	poetry install --all-extras
	poetry run pre-commit install --hook-type pre-commit --hook-type pre-push

build:
	poetry build

test:
ifdef ONLY
	# make test ONLY="tests.test_template tests.test_metadata"
	poetry run python -m unittest $(ONLY)
else
	poetry run python -m unittest discover tests
endif

test-unit:
	poetry run python -m unittest "tests.test_unit_tests"

test-integration:
	poetry run python scripts/run_e2e_notebooks.py

docs:
	rm -rf docs/_build
ifeq ($(shell uname),Darwin)
	poetry run pdoc validmind !validmind.tests.data_validation.Protected* -d google -t docs/templates --no-show-source --logo https://vmai.s3.us-west-1.amazonaws.com/validmind-logo.svg --favicon https://vmai.s3.us-west-1.amazonaws.com/favicon.ico -o docs/_build
else
	poetry run pdoc validmind -d google -t docs/templates --no-show-source --logo https://vmai.s3.us-west-1.amazonaws.com/validmind-logo.svg --favicon https://vmai.s3.us-west-1.amazonaws.com/favicon.ico -o docs/_build
endif

docs-serve:
ifeq ($(shell uname),Darwin)
	poetry run pdoc validmind !validmind.tests.data_validation.Protected* -d google -t docs/templates --no-show-source --logo https://vmai.s3.us-west-1.amazonaws.com/validmind-logo.svg --favicon https://vmai.s3.us-west-1.amazonaws.com/favicon.ico
else
	poetry run pdoc validmind -d google -t docs/templates --no-show-source --logo https://vmai.s3.us-west-1.amazonaws.com/validmind-logo.svg --favicon https://vmai.s3.us-west-1.amazonaws.com/favicon.ico
endif

quarto-docs:
	# Clean old files
	rm -f docs/validmind.json
	rm -rf docs/validmind
	mkdir -p docs/validmind

	# Generate API JSON dump
	poetry run python -m griffe dump validmind -f -o docs/validmind.json -d google -r -U

	# Generate Quarto docs from templates
	poetry run python scripts/generate_quarto_docs.py

version:
	@:$(call check_defined, tag, new semver version tag to use on pyproject.toml)
	@poetry version $(tag)
	@echo "__version__ = \"$$(poetry version -s)\"" > validmind/__version__.py
	@sed -i '' 's/^Version: .*/Version: '"$$(poetry version -s)"'/' r/validmind/DESCRIPTION
	@echo "Version updated to $$(poetry version -s)"
	@echo "Commiting changes to pyproject.toml, __version__.py and r/validmind/DESCRIPTION with message: $$(poetry version -s)"
	@git add pyproject.toml validmind/__version__.py r/validmind/DESCRIPTION
	@git commit -m "$$(poetry version -s)"

generate-test-id-types:
	poetry run python scripts/generate_test_id_type.py

copyright:
	poetry run python scripts/copyright_files.py
	poetry run python scripts/copyright_notebooks.py

verify-copyright:
	poetry run python scripts/verify_copyright.py
	poetry run python scripts/verify_notebook_copyright.py

verify-exposed-credentials:
	poetry run python scripts/credentials_check.py

ensure-clean-notebooks:
	poetry run python scripts/ensure_clean_notebooks.py

# Quick target to run all checks
check: copyright format lint test verify-copyright verify-exposed-credentials ensure-clean-notebooks

.PHONY: docs quarto-docs

notebook:
	poetry run python notebooks/templates/e2e_template.py
	git status | grep -v 'notebooks/templates'