shacl2code 0.0.2__tar.gz → 0.0.4__tar.gz

{shacl2code-0.0.2 → shacl2code-0.0.4}/.github/workflows/publish.yaml

@@ -1,10 +1,18 @@
 ---
 name: Upload Python Package
 on:
-  - push
+  release:
+    types:
+      - published
 
 jobs:
+  test:
+    uses: ./.github/workflows/test.yaml
+
   deploy:
+    needs:
+      - test
+
     runs-on: ubuntu-latest
     permissions:
       id-token: write
@@ -25,12 +33,5 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Publish distribution to Test PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          repository-url: https://test.pypi.org/legacy/
-          skip-existing: true
-
       - name: Publish distribution to PyPI
-        if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@release/v1

{shacl2code-0.0.2 → shacl2code-0.0.4}/.github/workflows/test.yaml

@@ -3,6 +3,7 @@ name: Test shacl2code
 on:
   - push
   - pull_request
+  - workflow_call
 
 jobs:
   build:
@@ -28,6 +29,12 @@ jobs:
       - name: Build package
         run: |
           python -m build
+      - name: Install package
+        run: |
+          pip install -e .[dev]
+      - name: Run tests
+        run: |
+          pytest -v
   lint:
     runs-on: ubuntu-latest
     steps:

{shacl2code-0.0.2 → shacl2code-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shacl2code
-Version: 0.0.2
+Version: 0.0.4
 Summary: Convert SHACL model file to code bindings
 Project-URL: Homepage, https://github.com/JPEWdev/shacl2code
 Project-URL: Repository, https://github.com/JPEWdev/shacl2code.git
@@ -19,9 +19,40 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Dist: jinja2>=3.1.2
 Requires-Dist: pyld>=2.0.3
+Provides-Extra: dev
+Requires-Dist: pytest-server-fixtures>=1.7; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Convert SHACL Model to code bindings
 
 This tool can be used to convert a JSONLD SHACL model into various code
 bindings
+
+## Installation
+
+`shacl2code` can be installed using pip:
+
+```shell
+python3 -m pip install shacl2code
+```
+
+## Usage
+
+`shacl2code` can generate bindings from either a local file:
+```shell
+shacl2code generate -i model.jsonld python -o out.py
+```
+Or from a URL:
+```shell
+shacl2code generate -i https://spdx.github.io/spdx-3-model/model.jsonld python -o out.py
+```
+Or from stdin:
+```shell
+cat model.jsonld | shacl2code generate -i - python -o - > out.py
+```
+
+For more information, run:
+```shell
+shacl2code --help
+```

shacl2code-0.0.4/README.md

@@ -0,0 +1,32 @@
+# Convert SHACL Model to code bindings
+
+This tool can be used to convert a JSONLD SHACL model into various code
+bindings
+
+## Installation
+
+`shacl2code` can be installed using pip:
+
+```shell
+python3 -m pip install shacl2code
+```
+
+## Usage
+
+`shacl2code` can generate bindings from either a local file:
+```shell
+shacl2code generate -i model.jsonld python -o out.py
+```
+Or from a URL:
+```shell
+shacl2code generate -i https://spdx.github.io/spdx-3-model/model.jsonld python -o out.py
+```
+Or from stdin:
+```shell
+cat model.jsonld | shacl2code generate -i - python -o - > out.py
+```
+
+For more information, run:
+```shell
+shacl2code --help
+```

shacl2code-0.0.4/conftest.py

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+import pytest
+from pytest_server_fixtures.http import SimpleHTTPTestServer
+
+
+@pytest.fixture
+def http_server():
+    with SimpleHTTPTestServer() as s:
+        s.start()
+        yield s

{shacl2code-0.0.2 → shacl2code-0.0.4}/pyproject.toml

@@ -24,6 +24,12 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest >= 7.4",
+    "pytest-server-fixtures >= 1.7"
+]
+
 [project.urls]
 Homepage = "https://github.com/JPEWdev/shacl2code"
 Repository = "https://github.com/JPEWdev/shacl2code.git"
@@ -37,4 +43,9 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.version]
-path = "shacl2code/version.py"
+path = "src/shacl2code/version.py"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]

{shacl2code-0.0.2 → shacl2code-0.0.4/src}/shacl2code/__init__.py

@@ -1,2 +1,3 @@
 from .model import Model
 from .main import main
+from .version import VERSION

shacl2code-0.0.4/src/shacl2code/__main__.py

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

shacl2code-0.0.4/src/shacl2code/lang/__init__.py

@@ -0,0 +1,10 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+from .lang import LANGUAGES
+
+# All renderers must be imported here to be registered
+from .python import PythonRender
+from .raw import RawRender

shacl2code-0.0.4/src/shacl2code/lang/common.py

@@ -0,0 +1,71 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+import sys
+import os
+from contextlib import contextmanager
+from pathlib import Path
+from jinja2 import Environment, FileSystemLoader, TemplateRuntimeError
+
+from ..const import TEMPLATE_DIR
+
+
+class OutputFile(object):
+    def __init__(self, path):
+        self.path = path
+
+    @contextmanager
+    def open(self):
+        if self.path == "-":
+            yield sys.stdout
+        else:
+            with open(self.path, "w") as f:
+                yield f
+
+
+class BasicJinjaRender(object):
+    """
+    Common Jinja Template Renderer
+
+    Renderers that only use a single Jinja file can derive from this class. The
+    class should set the class member variable `TEMPLATE` to indicate which
+    template file to use. For example:
+
+        @language("my-lang")
+        class MyRendered(BasicJinjaRenderer):
+            HELP = "Generates my-lang bindings"
+            TEMPLATE = "my-lang.j2"
+
+    """
+
+    def __init__(self):
+        pass
+
+    @classmethod
+    def get_arguments(cls, parser):
+        parser.add_argument(
+            "--output",
+            "-o",
+            type=OutputFile,
+            help="Output file or '-' for stdout",
+            required=True,
+        )
+
+    def output(self, args, model):
+        def abort_helper(msg):
+            raise TemplateRuntimeError(msg)
+
+        env = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
+        env.globals["abort"] = abort_helper
+        template = env.get_template(self.TEMPLATE)
+
+        render = template.render(
+            disclaimer=f"This file was automatically generated by {os.path.basename(sys.argv[0])}. DO NOT MANUALLY MODIFY IT",
+            enums=model.get_template_enums(),
+            classes=model.get_template_classes(),
+        )
+
+        with args.output.open() as f:
+            f.write(render)

shacl2code-0.0.4/src/shacl2code/lang/lang.py

@@ -0,0 +1,15 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+LANGUAGES = {}
+
+
+def language(name):
+    def inner(cls):
+        global LANGUAGES
+        LANGUAGES[name] = cls
+        return cls
+
+    return inner

shacl2code-0.0.4/src/shacl2code/lang/python.py

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+from .common import BasicJinjaRender
+from .lang import language
+
+
+@language("python")
+class PythonRender(BasicJinjaRender):
+    HELP = "Python Language Bindings"
+    TEMPLATE = "python.j2"

shacl2code-0.0.4/src/shacl2code/lang/raw.py

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+from .common import BasicJinjaRender
+from .lang import language
+
+
+@language("raw")
+class RawRender(BasicJinjaRender):
+    HELP = "Raw Jinja Output (for testing)"
+    TEMPLATE = "raw.j2"

shacl2code-0.0.4/src/shacl2code/main.py

@@ -0,0 +1,93 @@
+#! /usr/bin/env python3
+#
+# Copyright (c) 2024 Joshua Watt
+#
+# SPDX-License-Identifier: MIT
+
+import argparse
+import json
+import sys
+import urllib.request
+from pathlib import Path
+
+from . import Model
+from .version import VERSION
+from .lang import LANGUAGES
+
+
+def main():
+    def handle_generate(args):
+        if "://" in args.input:
+            with urllib.request.urlopen(args.input) as url:
+                model_data = json.load(url)
+        elif args.input == "-":
+            model_data = json.load(sys.stdin)
+        else:
+            with Path(args.input).open("r") as f:
+                model_data = json.load(f)
+
+        m = Model(model_data)
+
+        render = args.lang()
+        render.output(args, m)
+        return 0
+
+    def handle_list(args):
+        width = max(len(lang) for lang in LANGUAGES)
+        for k, v in LANGUAGES.items():
+            if args.short:
+                print(k)
+            else:
+                print(f"{k:{width}} - {v.HELP}")
+
+        return 0
+
+    def handle_version(args):
+        print(VERSION)
+        return 0
+
+    parser = argparse.ArgumentParser(
+        description=f"Convert JSON-LD model to python. Version {VERSION}"
+    )
+    command_subparser = parser.add_subparsers(
+        title="command",
+        description="Command to execute",
+        required=True,
+    )
+    generate_parser = command_subparser.add_parser(
+        "generate",
+        help="Generate language bindings",
+    )
+    generate_parser.add_argument(
+        "--input",
+        "-i",
+        help="Input JSON-LD model (path, URL, or '-')",
+        required=True,
+    )
+    generate_parser.set_defaults(func=handle_generate)
+
+    lang_subparser = generate_parser.add_subparsers(
+        title="language",
+        description="Language to generate",
+        required=True,
+    )
+    for k, v in LANGUAGES.items():
+        p = lang_subparser.add_parser(k, help=v.HELP)
+        v.get_arguments(p)
+        p.set_defaults(lang=v)
+
+    list_parser = command_subparser.add_parser("list", help="List languages")
+    list_parser.add_argument(
+        "--short",
+        "-s",
+        action="store_true",
+        help="Only list languages without descriptions",
+    )
+    list_parser.set_defaults(func=handle_list)
+
+    version_parser = command_subparser.add_parser("version", help="Show version")
+    version_parser.set_defaults(func=handle_version)
+
+    args = parser.parse_args()
+
+    return args.func(args)

{shacl2code-0.0.2 → shacl2code-0.0.4/src}/shacl2code/model.py

@@ -9,11 +9,6 @@ import re
 from pathlib import Path
 
 from pyld import jsonld
-from jinja2 import Environment, FileSystemLoader, TemplateRuntimeError
-
-from .const import TEMPLATE_DIR
-
-THIS_FILE = Path(__file__)
 
 
 def get_prop(o, name, key, default=None):
@@ -207,17 +202,3 @@ class Model(object):
             done_classes.add(clsname)
 
         return template_classes
-
-    def render_template(self, lang):
-        def abort_helper(msg):
-            raise TemplateRuntimeError(msg)
-
-        env = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
-        env.globals["abort"] = abort_helper
-        template = env.get_template(lang + ".j2")
-
-        return template.render(
-            disclaimer=f"This file was automatically generated by {THIS_FILE.name}. DO NOT MANUALLY MODIFY IT",
-            enums=self.get_template_enums(),
-            classes=self.get_template_classes(),
-        )

{shacl2code-0.0.2 → shacl2code-0.0.4/src}/shacl2code/templates/python.j2

@@ -858,3 +858,4 @@ if __name__ == "__main__":
     import sys
 
     sys.exit(main())
+

shacl2code-0.0.4/src/shacl2code/templates/raw.j2

@@ -0,0 +1,7 @@
+{% for enum in enums %}
+{{ enum -}}
+{% endfor %}
+{% for class in classes %}
+{{ class -}}
+{% endfor %}
+

shacl2code-0.0.4/src/shacl2code/version.py

@@ -0,0 +1 @@
+VERSION = "0.0.4"