Merge branch 'main' into fix/spec-parse-order

Author: jkowalleck

etc/scripts/doc-generation.txt

@@ -0,0 +1,20 @@
+2025-08-13 Wednesday 18:18:27 -- [email protected] -- The current process
+for generating (and regenerating as needed) the purl-standard.md and
+purl-specification.md files is a combination of manual and scripted steps.
+
+- Start with the set of .md files created from the former PURL-SPECIFICATION.rst
+  file.
+- Update one or more of those .md files as needed in a Visual Studio Code
+  instance running locally in a branch of a clone of the purl-spec repo.
+- Manually copy the full set of .md files to a separate VSCode instance for a
+  local repo running pypandoc.  See, e.g., https://pypi.org/project/pypandoc/.
+- Configure the code we've written to choose which compiled .md output we want
+  (purl-specification.md or purl-standard.md), the input .md files, and any
+  changes needed for heading names and numbers.
+- Run the code, vet the output .md, fix what needs fixing, and manually copy
+  the output .md back into the local purl-spec VSCode instance.
+- After careful vetting etc., commit, push, open a new PR if not already opened,
+  advise reviewers that the PR is ready for review, and wait for feedback.
+- Repeat when needed.
+
+The process is currently run on Windows using WSL2/Ubuntu-20.04.

etc/scripts/generate_index_and_docs.py

@@ -161,7 +161,7 @@ def generate_documentation(definition) -> str:
         mddoc.write_text(md, newline="\n")
         print(f"PURL Type Documentation generated for {mddoc}")
 
-    idxdoc =  Path("purl-types-index.json")
+    idxdoc = Path("purl-types-index.json")
     idx = json.dumps(sorted(types), indent=2) + "\n"
     idxdoc.write_text(idx, newline="\n")
     print(f"PURL Types Index generated at {idxdoc}")

etc/scripts/purl_test.py

@@ -22,14 +22,8 @@
 
 
 from __future__ import annotations
-
-from typing import Any
-from typing import Literal
-from typing import Optional
-
-from pydantic import BaseModel
-from pydantic import ConfigDict
-from pydantic import Field
+from typing import Any, Literal, Optional
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class PurlComponents(BaseModel):

etc/scripts/purl_type_definition.py

@@ -22,16 +22,8 @@
 
 
 from __future__ import annotations
-
-from typing import Any
-from typing import Literal
-from typing import Optional
-
-from pydantic import AnyUrl
-from pydantic import BaseModel
-from pydantic import ConfigDict
-from pydantic import Field
-from pydantic import RootModel
+from pydantic import AnyUrl, BaseModel, ConfigDict, Field, RootModel
+from typing import Any, Literal, Optional
 
 
 class Example(RootModel[str]):

etc/scripts/purl_types_index.py

@@ -22,9 +22,7 @@
 
 
 from __future__ import annotations
-
-from pydantic import Field
-from pydantic import RootModel
+from pydantic import Field, RootModel
 
 
 class PackageUrlTypesList(RootModel[list[str]]):