Convert to build as a module using hatchling

Converts the project to be structured so that it can be built into
wheels using `python3 -m build`. The build system chosen is hatchling,
because it is very simple to use.

Note that now instead of using ./main.py to invoke the script, the
module installs a command called `spec-parser` that is used instead

Author: JPEWdev

README.md

@@ -3,11 +3,24 @@
 Automagically process the 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]
+$ spec-parser -h
+usage: 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
+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
+spec-parser some/where/.../model some/where/else/.../output_dir
 ```
 
 

pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "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 = "Joshua Watt", 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]
+spec-parser = "spec_parser.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/spec_parser/__init__.py"

requirements.txt

@@ -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())

spec_parser/__init__.py renamed to src/spec_parser/__init__.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)