dsw-tdk 3.13.0__py3-none-any.whl → 4.27.0__py3-none-any.whl

dsw/tdk/templates/LICENSE.j2

@@ -0,0 +1 @@
+// TODO: fill text of your license ({{ template.license }})

{dsw_tdk → dsw/tdk}/templates/README.md.j2

@@ -1,13 +1,13 @@
-# {{ template.name }}
-
-{{ template.description }}
-
-## Changelog
-
-### {{ template.version }}
-
-- Initial version of {{ template.name }} template
-
-## License
-
-This template is released under {{ template.license }}. Read the LICENSE file for details.
+# {{ template.name }}
+
+{{ template.description }}
+
+## Changelog
+
+### {{ template.version }}
+
+- Initial version of {{ template.name }} template
+
+## License
+
+This template is released under {{ template.license }}. Read the LICENSE file for details.

dsw/tdk/templates/env.j2

@@ -0,0 +1,3 @@
+DSW_API_URL={{ api_url|default("http://localhost:3000") }}
+DSW_API_KEY={{ api_key|default("") }}
+

{dsw_tdk → dsw/tdk}/templates/starter.j2

@@ -1,14 +1,13 @@
-{%- raw -%}
-{# This is the template starter file generated by DSW TDK #}
-{%- set km = ctx.knowledgeModel -%}
-{%- set repliesMap = ctx.questionnaireReplies -%}
-
-{#
-##
-##  TODO: Write the template
-##  SEE: https://jinja.palletsprojects.com/templates/
-##
-##  ~~ Happy hacking! ~~
-##
-#}
-{% endraw %}
+{%- raw -%}
+{# This is the template starter file generated by DSW TDK #}
+{%- set dc = ctx|to_context_obj -%}
+
+{#
+##
+##  TODO: Write the template
+##  SEE: https://jinja.palletsprojects.com/templates/
+##
+##  ~~ Happy hacking! ~~
+##
+#}
+{% endraw %}

{dsw_tdk → dsw/tdk}/utils.py

@@ -1,173 +1,198 @@
-import jinja2  # type: ignore
-import pathlib
-import uuid
-
-from typing import List, Set
-
-from dsw_tdk.consts import DEFAULT_ENCODING, DEFAULT_README
-from dsw_tdk.model import Template, TemplateFile, Format, Step, PackageFilter
-from dsw_tdk.validation import TemplateValidator, FormatValidator, StepValidator
-
-j2_env = jinja2.Environment(
-    loader=jinja2.PackageLoader('dsw_tdk'),
-    extensions=['jinja2.ext.do'],
-    autoescape=True,
-)
-
-
-class UUIDGen:
-
-    _uuids = set()  # type: Set[uuid.UUID]
-
-    @classmethod
-    def used(cls) -> Set[uuid.UUID]:
-        return cls._uuids
-
-    @classmethod
-    def generate(cls) -> uuid.UUID:
-        result = uuid.uuid4()
-        while result in cls._uuids:
-            result = uuid.uuid4()
-        cls._uuids.add(result)
-        return result
-
-
-class FormatSpec:
-
-    def __init__(self):
-        self.format = Format()
-        self.step = Step(
-            name='jinja',
-            options={
-                'template': 'template.html.j2',
-                'content-type': 'text/html',
-                'extension': 'html',
-            }
-        )
-        self.format.uuid = str(UUIDGen.generate())
-        self.format.steps.append(self.step)
-
-    @property
-    def name(self):
-        return self.format.name
-
-    @name.setter
-    def name(self, value: str):
-        self.format.name = value
-        FormatValidator.validate_field(self.format, 'name')
-
-    @property
-    def content_type(self):
-        return self.step.options['content-type']
-
-    @content_type.setter
-    def content_type(self, value: str):
-        self.step.options['content-type'] = value
-        StepValidator.validate(self.step, 'format')
-
-    @property
-    def file_extension(self):
-        return self.step.options['extension']
-
-    @file_extension.setter
-    def file_extension(self, value: str):
-        self.step.options['extension'] = value
-        self.format.short_name = value
-        StepValidator.validate(self.step, 'format')
-
-    @property
-    def filename(self):
-        return self.step.options['template']
-
-    @filename.setter
-    def filename(self, value: str):
-        self.step.options['template'] = str(pathlib.PurePosixPath(pathlib.Path(value)))
-        StepValidator.validate(self.step, 'format')
-
-
-class TemplateBuilder:
-
-    def __init__(self):
-        self.template = Template()
-        self._formats = []  # type: List[FormatSpec]
-
-    @property
-    def formats(self) -> List[FormatSpec]:
-        return self._formats
-
-    def _validate_field(self, field_name: str):
-        TemplateValidator.validate_field(self.template, field_name)
-
-    def add_format(self, format_spec: FormatSpec):
-        self._formats.append(format_spec)
-        self.template.formats.append(format_spec.format)
-
-    @property
-    def name(self):
-        return self.template.name
-
-    @name.setter
-    def name(self, value: str):
-        self.template.name = value
-        self._validate_field('name')
-
-    @property
-    def template_id(self):
-        return self.template.template_id
-
-    @template_id.setter
-    def template_id(self, value: str):
-        self.template.template_id = value
-        self._validate_field('template_id')
-
-    @property
-    def organization_id(self):
-        return self.template.organization_id
-
-    @organization_id.setter
-    def organization_id(self, value: str):
-        self.template.organization_id = value
-        self._validate_field('organization_id')
-
-    @property
-    def version(self):
-        return self.template.version
-
-    @version.setter
-    def version(self, value: str):
-        self.template.version = value
-        self._validate_field('version')
-
-    @property
-    def description(self):
-        return self.template.description
-
-    @description.setter
-    def description(self, value: str):
-        self.template.description = value
-        self._validate_field('description')
-
-    @property
-    def license(self):
-        return self.template.license
-
-    @license.setter
-    def license(self, value: str):
-        self.template.license = value
-        self._validate_field('license')
-
-    def build(self) -> Template:
-        readme = j2_env.get_template('README.md.j2').render(template=self.template)
-        self.template.readme = readme
-        self.template.tdk_config.readme_file = DEFAULT_README
-        TemplateValidator.validate(self.template)
-        for format_spec in self._formats:
-            content = j2_env.get_template('starter.j2').render(template=self.template)
-            self.template.files[format_spec.filename] = TemplateFile(
-                filename=format_spec.filename,
-                content_type='text/plain',
-                content=content.encode(encoding=DEFAULT_ENCODING)
-            )
-            self.template.tdk_config.files.append(str(format_spec.filename))
-        self.template.allowed_packages.append(PackageFilter())
-        return self.template
+import pathlib
+import uuid
+
+import jinja2
+
+from . import consts
+from .model import Format, PackageFilter, Step, Template, TemplateFile
+from .validation import FormatValidator, StepValidator, TemplateValidator
+
+
+TEMPLATES_DIR = pathlib.Path(__file__).parent / 'templates'
+
+j2_env = jinja2.Environment(
+    loader=jinja2.FileSystemLoader(TEMPLATES_DIR),
+    extensions=['jinja2.ext.do'],
+    autoescape=True,
+)
+
+
+class UUIDGen:
+
+    _uuids: set[uuid.UUID] = set()
+
+    @classmethod
+    def used(cls) -> set[uuid.UUID]:
+        return cls._uuids
+
+    @classmethod
+    def generate(cls) -> uuid.UUID:
+        result = uuid.uuid4()
+        while result in cls._uuids:
+            result = uuid.uuid4()
+        cls._uuids.add(result)
+        return result
+
+
+class FormatSpec:
+
+    def __init__(self):
+        self.format = Format()
+        self.step = Step(
+            name='jinja',
+            options={
+                'template': 'template.html.j2',
+                'content-type': 'text/html',
+                'extension': 'html',
+            },
+        )
+        self.format.uuid = str(UUIDGen.generate())
+        self.format.steps.append(self.step)
+
+    @property
+    def name(self):
+        return self.format.name
+
+    @name.setter
+    def name(self, value: str):
+        self.format.name = value
+        FormatValidator.validate_field(self.format, 'name')
+
+    @property
+    def content_type(self):
+        return self.step.options['content-type']
+
+    @content_type.setter
+    def content_type(self, value: str):
+        self.step.options['content-type'] = value
+        StepValidator.validate(self.step, 'format')
+
+    @property
+    def file_extension(self):
+        return self.step.options['extension']
+
+    @file_extension.setter
+    def file_extension(self, value: str):
+        self.step.options['extension'] = value
+        StepValidator.validate(self.step, 'format')
+
+    @property
+    def filename(self):
+        return self.step.options['template']
+
+    @filename.setter
+    def filename(self, value: str):
+        self.step.options['template'] = str(pathlib.PurePosixPath(pathlib.Path(value)))
+        StepValidator.validate(self.step, 'format')
+
+
+class TemplateBuilder:
+
+    def __init__(self):
+        self.template = Template()
+        self._formats: list[FormatSpec] = []
+
+    @property
+    def formats(self) -> list[FormatSpec]:
+        return self._formats
+
+    def _validate_field(self, field_name: str):
+        TemplateValidator.validate_field(self.template, field_name)
+
+    def add_format(self, format_spec: FormatSpec):
+        self._formats.append(format_spec)
+        self.template.formats.append(format_spec.format)
+
+    @property
+    def name(self):
+        return self.template.name
+
+    @name.setter
+    def name(self, value: str):
+        self.template.name = value
+        self._validate_field('name')
+
+    @property
+    def template_id(self):
+        return self.template.template_id
+
+    @template_id.setter
+    def template_id(self, value: str):
+        self.template.template_id = value
+        self._validate_field('template_id')
+
+    @property
+    def organization_id(self):
+        return self.template.organization_id
+
+    @organization_id.setter
+    def organization_id(self, value: str):
+        self.template.organization_id = value
+        self._validate_field('organization_id')
+
+    @property
+    def version(self):
+        return self.template.version
+
+    @version.setter
+    def version(self, value: str):
+        self.template.version = value
+        self._validate_field('version')
+
+    @property
+    def description(self):
+        return self.template.description
+
+    @description.setter
+    def description(self, value: str):
+        self.template.description = value
+        self._validate_field('description')
+
+    @property
+    def license(self):
+        return self.template.license
+
+    @license.setter
+    def license(self, value: str):
+        self.template.license = value
+        self._validate_field('license')
+
+    def build(self) -> Template:
+        readme = j2_env.get_template('README.md.j2').render(template=self.template)
+        self.template.readme = readme
+        self.template.tdk_config.readme_file = consts.DEFAULT_README
+        TemplateValidator.validate(self.template)
+
+        for format_spec in self._formats:
+            content = j2_env.get_template('starter.j2').render(template=self.template)
+            self.template.files[format_spec.filename] = TemplateFile(
+                filename=format_spec.filename,
+                content_type='text/plain',
+                content=content.encode(encoding=consts.DEFAULT_ENCODING),
+            )
+        self.template.tdk_config.files = ['src/**/*', '!.git/', '!.env']
+        self.template.allowed_packages.append(PackageFilter())
+
+        license_file = j2_env.get_template('LICENSE.j2').render(template=self.template)
+        self.template.tdk_config.files.append('LICENSE')
+        self.template.files['LICENSE'] = TemplateFile(
+            filename=pathlib.Path('LICENSE'),
+            content_type='text/plain',
+            content=license_file.encode(encoding=consts.DEFAULT_ENCODING),
+        )
+
+        self.template.files['.env'] = TemplateFile(
+            filename=pathlib.Path('.env'),
+            content_type='text/plain',
+            content=create_dot_env().encode(encoding=consts.DEFAULT_ENCODING),
+        )
+
+        return self.template
+
+
+def create_dot_env(api_url: str | None = None, api_key: str | None = None) -> str:
+    return j2_env.get_template('env.j2').render(api_url=api_url, api_key=api_key)
+
+
+def safe_utf8(text: str) -> str:
+    return text.encode(encoding='utf-8', errors='ignore').decode(encoding='utf-8')