Convert to build as a module using hatchling

.gitignore

@@ -23,3 +23,8 @@ docs/_build
 # Virtual Env        #
 ######################
 venv
+.venv
+
+# Wheel build output #
+######################
+dist/

README.md

@@ -1,13 +1,26 @@
-# spec-parser
+# md-spec-parser
 
-Automagically process the model of the SPDXv3 specification to validate input or to generate stuff.
+Automagically process the Markdown model of the SPDXv3 specification to validate input or to generate stuff.
 
 
+## Installation
+
+```
+# Create virtual environment
+python3 -m venv venv
+
+# Activate virtual environment
+. ./venv/bin/activate
+
+# Install module and dependencies in editable mode
+pip install -e .
+```
+
 ## Usage
 
 ```
-python3 ./main.py  -h 
-usage: main.py [-h] [-d] [-f] [-n] [-q] [-v] [-V] input_dir [output_dir]
+$ md-spec-parser -h
+usage: md-spec-parser [-h] [-d] [-f] [-n] [-q] [-v] [-V] input_dir [output_dir]
 
 Generate documentation from an SPDX 3.0 model
 
@@ -30,15 +43,12 @@ Note that not all flags are functional yet.
 ### Checking input
 
 ```
-python3 main.py -n some/where/.../model
+md-spec-parser -n some/where/.../model
 ```
 
-Note that no dependencies are needed.
-
 ### Generate output
 ```
-python3 -m pip install -r requirements.txt
-python3 main.py some/where/.../model some/where/else/.../output_dir
+md-spec-parser some/where/.../model some/where/else/.../output_dir
 ```
 
 

pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "md-spec-parser"
+description = "Parse SPDX Spec Markdown Files"
+dynamic = ["version"]
+dependencies = [
+    "Jinja2 == 3.1.2",
+    "jsonpickle == 3.0.2",
+    "rdflib == 7.0.0",
+]
+required-python = ">= 3.8"
+authors = [
+    {name = "Alexios Zavras", email = "[email protected]"},
+]
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+[project.urls]
+Homepage = "https://github.com/spdx/spec-parser"
+Repository = "https://github.com/spdx/spec-parser.git"
+Issues = "https://github.com/spdx/spec-parser/issues"
+
+[project.scripts]
+md-spec-parser = "md_spec_parser.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/md_spec_parser/__init__.py"

src/md_spec_parser/__main__.py

@@ -0,0 +1,12 @@
+#! /usr/bin/env python3
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+import sys
+
+from .main import main
+
+if __name__ == "__main__":
+    sys.exit(main())

main.py → src/md_spec_parser/main.py

@@ -2,10 +2,10 @@
 
 # SPDX-License-Identifier: Apache-2.0
 
-from spec_parser import Model
-from runparams import RunParams
+from . import Model
+from .runparams import RunParams
 
-if __name__ == "__main__":
+def main():
     cfg = RunParams()
 
     m = Model(cfg.input_dir)

spec_parser/mkdocs.py → src/md_spec_parser/mkdocs.py

@@ -13,9 +13,9 @@ def gen_mkdocs(model, dir, cfg):
         if not cfg.opt_force:
             logging.error(f"Destination for mkdocs {dir} already exists, will not overwrite")
             return
-    
+
     jinja = Environment(
-        loader=PackageLoader("spec_parser", package_path="templates/mkdocs"),            
+        loader=PackageLoader("md_spec_parser", package_path="templates/mkdocs"),
         autoescape=select_autoescape(),
         trim_blocks=True, lstrip_blocks=True
     )
@@ -60,7 +60,7 @@ def class_link(name):
         _, other_ns, name = name.split("/")
         return f"[/{other_ns}/{name}](../../{other_ns}/Classes/{name}.md)"
     else:
-        return f"[{name}](../Classes/{name}.md)"    
+        return f"[{name}](../Classes/{name}.md)"
 
 
 def property_link(name):

runparams.py → src/md_spec_parser/runparams.py

@@ -12,19 +12,19 @@ def __init__(self):
         self._ts = datetime.now(timezone.utc)
         self.process_args()
 
-    
+
     @property
     def autogen_header(self):
         return f"Automatically generated by spec-parser v{self.parser_version} on {self._ts.isoformat()}"
 
     @property
     def input_dir(self):
         return self.args.input_dir
-    
+
     @property
     def output_dir(self):
         return self.args.output_dir
-    
+
     @property
     def opt_debug(self):
         return self.args.debug
@@ -36,7 +36,7 @@ def opt_force(self):
     @property
     def opt_nooutput(self):
         return self.args.nooutput
-    
+
     @property
     def opt_quiet(self):
         return self.args.quiet
@@ -47,8 +47,9 @@ def opt_verbose(self):
 
     @property
     def parser_version(self):
-        return sys.modules['spec_parser'].__version__
-
+        import md_spec_parser
+        return md_spec_parser.__version__
+
     @property
     def all_as_dict(self):
         return { k: getattr(self, k) for k in (
@@ -66,7 +67,7 @@ def all_as_dict(self):
 # - separate output dirs for mkdocs / RDF /JSON-LD / ...
 # - maybe flags whether something might not be generated?
 # - etc.
-    
+
     def process_args(self, args=sys.argv[1:]):
         parser = argparse.ArgumentParser(description="Generate documentation from an SPDX 3.0 model")
         parser.add_argument("input_dir", help="Directory containing the input specification files")
@@ -76,7 +77,7 @@ def process_args(self, args=sys.argv[1:]):
         parser.add_argument("-n", "--nooutput", action="store_true", help="Do not generate anything, only check input")
         parser.add_argument("-q", "--quiet", action="store_true", help="Print no output")
         parser.add_argument("-v", "--verbose", action="store_true", help="Print verbose output")
-        parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {RunParams.parser_version}")
+        parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {self.parser_version}")
         self.args = parser.parse_args(args)
 
         if self.opt_nooutput: