Merge pull request package-url#514 from package-url/purl_type_schema-refined

Refine Purl type schema

Author: pombredanne

.github/workflows/generate-index-and-docs.yml

@@ -0,0 +1,45 @@
+name: Check and generate PURL Type Docs and Index
+
+on:
+  push:
+    paths:
+      - "types/*.json"
+      - "schemas/*.json"
+      - "etc/"
+    branches:
+      - main
+  workflow_dispatch:
+# All permissions should be specified at the job level
+permissions: { }
+
+jobs:
+  generate-index-and-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      content: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: make conf
+
+      - name: Validate code and data formats
+        run: make check
+
+      - name: Generate index and docs
+        run: make gendocs
+
+      - name: Commit and push changes
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add types/ types-doc/
+          git commit -s -m "Generate updated PURL type documentation" || echo "No changes to commit"
+          git push

.gitignore

@@ -1 +1,4 @@
 /tmp/
+/venv/
+/.python-version
+.ruff_cache/

Makefile

@@ -0,0 +1,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