purl-spec/Makefile at main · s-kenji/purl-spec · 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
# SPDX-License-Identifier: MIT
# Copyright (c) the purl authors
# Visit https://github.com/package-url/purl-spec and https://packageurl.org for support

PYTHON_EXE?=python3
VENV_LOCATION=venv
ACTIVATE?=. ${VENV_LOCATION}/bin/activate;

CODEGEN?=datamodel-codegen \
    --target-python-version 3.10 \
    --use-double-quotes \
    --use-exact-imports \
    --use-standard-collections \
    --wrap-string-literal \
    --enum-field-as-literal all \
    --formatters ruff-format \
    --field-constraints \
    --disable-timestamp \
    --keep-model-order \
    --custom-file-header-path LICENSE \
    --input-file-type jsonschema \
    --output-model-type pydantic_v2.BaseModel

virtualenv:
	@echo "-> Bootstrap the virtualenv with PYTHON_EXE=${PYTHON_EXE}"
	${PYTHON_EXE} -m venv ${VENV_LOCATION}

conf: virtualenv
	@echo "-> Install dependencies"
	@${ACTIVATE} pip install -r etc/scripts/requirements.txt

formatcode:
	@echo "-> Run Ruff format"
	@${ACTIVATE} ruff check --select I --fix
	@${ACTIVATE} ruff format
	@echo "-> Run Ruff linter"
	@${ACTIVATE} ruff check --fix

formatjson:
	@echo "-> Format JSON files"
	@${ACTIVATE} python etc/scripts/format_json.py schemas/
	@${ACTIVATE} python etc/scripts/format_json.py types/
	@${ACTIVATE} python etc/scripts/format_json.py tests/

format: formatcode formatjson
	@echo "-> Format all files"

checkjson:
	@echo "-> Validate JSON schemas"
	@${ACTIVATE} check-jsonschema --check-metaschema --verbose schemas/*.json
	@echo "-> Validate JSON data files against the schemas"
	@${ACTIVATE} check-jsonschema --schemafile schemas/purl-types-index.schema.json --verbose purl-types-index.json
	@${ACTIVATE} check-jsonschema --schemafile schemas/purl-type-definition.schema.json --verbose types/*-definition.json
	@${ACTIVATE} check-jsonschema --schemafile schemas/purl-test.schema.json --verbose tests/*/*-test.json

checkcode:
	@echo "-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)"
	@${ACTIVATE} ruff --config etc/scripts/pyproject.toml check
	@echo "-> Run Ruff format validation"
	@${ACTIVATE} ruff --config etc/scripts/pyproject.toml format --check

check: checkjson checkcode
	@echo "-> Run all checks"

clean:
	@echo "-> Clean the Python env"
	rm -rf .venv/
	find . -type f -name '*.py[co]' -delete

gencode:
	@echo "-> Generate Python code from schemas"
	@${ACTIVATE} ${CODEGEN} \
	    --input schemas/purl-types-index.schema.json \
	    --output etc/scripts/purl_types_index.py
	@${ACTIVATE} ${CODEGEN} \
	    --input schemas/purl-type-definition.schema.json \
	    --output etc/scripts/purl_type_definition.py
	@${ACTIVATE} ${CODEGEN} \
	    --input schemas/purl-test.schema.json \
	    --output etc/scripts/purl_test.py
	@echo "-> Run Black format for generated code"
	@${ACTIVATE} black -l 100 --preview --enable-unstable-feature string_processing etc/scripts/*.py

gendocs:
	@${ACTIVATE} python etc/scripts/generate_index_and_docs.py


.PHONY: virtualenv conf formatcode formatjson format checkcode checkjson check clean gencode gendocs