dsw-tdk 4.16.0__tar.gz → 4.17.0__tar.gz

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/CHANGELOG.md

@@ -8,6 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 
+## [4.17.0]
+
+### Added
+
+- Add check for no matching files (warning and use of defaults)
+
+### Changed
+
+- Unified IDs (organization, document template, knowledge model)
+
 ## [4.16.0]
 
 Released for version consistency with other DSW tools.
@@ -529,3 +539,4 @@ Initial DSW Template Development Kit (versioned as part of the [DSW platform](ht
 [4.14.0]: /../../tree/v4.14.0
 [4.15.0]: /../../tree/v4.15.0
 [4.16.0]: /../../tree/v4.16.0
+[4.17.0]: /../../tree/v4.17.0

{dsw_tdk-4.16.0/dsw_tdk.egg-info → dsw_tdk-4.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dsw-tdk
-Version: 4.16.0
+Version: 4.17.0
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -32,6 +32,7 @@ Requires-Dist: python-slugify
 Requires-Dist: watchfiles
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
 
 # dsw-tdk
 

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/dsw/tdk/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v4.16.0~ed2a8b4',
-    built_at='2025-03-06 15:23:41Z',
-    sha='ed2a8b48c8a350de3dc428124cecbd38fa9b865c',
+    version='v4.17.0~ac8947f',
+    built_at='2025-04-01 06:47:55Z',
+    sha='ac8947fd0b7824e803d28f8d15215263a810aee8',
     branch='HEAD',
-    tag='v4.16.0',
+    tag='v4.17.0',
 )

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/dsw/tdk/consts.py

@@ -4,13 +4,14 @@ import re
 import pathspec
 
 APP = 'dsw-tdk'
-VERSION = '4.16.0'
+VERSION = '4.17.0'
 METAMODEL_VERSION = 16
 
 REGEX_SEMVER = re.compile(r'^[0-9]+\.[0-9]+\.[0-9]+$')
-REGEX_ORGANIZATION_ID = re.compile(r'^(?![.])(?!.*[.]$)[a-zA-Z0-9.]+$')
-REGEX_TEMPLATE_ID = re.compile(r'^(?![-])(?!.*[-]$)[a-zA-Z0-9-]+$')
-REGEX_KM_ID = REGEX_TEMPLATE_ID
+REGEX_WIZARD_ID = re.compile(r'^[a-zA-Z0-9-_.]+$')
+REGEX_ORGANIZATION_ID = REGEX_WIZARD_ID
+REGEX_TEMPLATE_ID = REGEX_WIZARD_ID
+REGEX_KM_ID = REGEX_WIZARD_ID
 REGEX_MIME_TYPE = re.compile(r'^(?![-])(?!.*[-]$)[-\w.]+/[-\w.]+$')
 
 DEFAULT_LIST_FORMAT = '{template.id:<50} {template.name:<30}'

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/dsw/tdk/core.py

@@ -165,6 +165,10 @@ class TDKCore:
         if self.project is None:
             raise RuntimeError('No template project is initialized')
         self.project.template = self.safe_template
+        if len(self.project.template.tdk_config.files) == 0:
+            self.project.template.tdk_config.use_default_files()
+            self.logger.warning('Using default _tdk.files in template.json, you may want '
+                                'to change it to include relevant files')
         self.logger.debug('Initiating storing local template project (force=%s)', force)
         self.project.store(force=force)
 
@@ -301,6 +305,9 @@ class TDKCore:
                               tfile.remote_type.value, tfile.filename.as_posix(), e)
 
     async def store_remote_files(self):
+        if len(self.safe_project.safe_template.files) == 0:
+            self.logger.warning('No files to store, maybe you forgot to '
+                                'update _tdk.files patterns in template.json?')
         for tfile in self.safe_project.safe_template.files.values():
             tfile.remote_id = None
             tfile.remote_type = TemplateFileType.FILE if tfile.is_text else TemplateFileType.ASSET
@@ -333,6 +340,9 @@ class TDKCore:
                     pkg.writestr(f'template/assets/{tfile.filename.as_posix()}', tfile.content)
             descriptor['files'] = files
             descriptor['assets'] = assets
+            if len(files) == 0 and len(assets) == 0:
+                self.logger.warning('No files or assets found in the template, maybe you forgot '
+                                    'to update _tdk.files patterns in template.json?')
             timestamp = datetime.datetime.now(tz=datetime.UTC).strftime('%Y-%m-%dT%H:%M:%S.%fZ')
             descriptor['createdAt'] = timestamp
             descriptor['updatedAt'] = timestamp
@@ -355,7 +365,9 @@ class TDKCore:
                 raise RuntimeError('Malformed package: missing template.json file')
             data = json.loads(template_file.read_text(encoding=DEFAULT_ENCODING))
             template = Template.load_local(data)
-            template.tdk_config.files = ['*', '!.git/', '!.env']
+            template.tdk_config.use_default_files()
+            self.logger.warning('Using default _tdk.files in template.json, you may want '
+                                'to change it to include relevant files')
             self.logger.debug('Preparing template dir')
             if template_dir is None:
                 template_dir = pathlib.Path.cwd() / template.id.replace(':', '_')
@@ -372,8 +384,8 @@ class TDKCore:
                 encoding=DEFAULT_ENCODING,
             )
             self.logger.debug('Extracting README.md from package')
-            local_template_json = template_dir / 'README.md'
-            local_template_json.write_text(
+            local_readme = template_dir / 'README.md'
+            local_readme.write_text(
                 data=data['readme'].replace('\r\n', '\n'),
                 encoding=DEFAULT_ENCODING,
             )

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/dsw/tdk/model.py

@@ -101,7 +101,7 @@ class Format:
 class TDKConfig:
 
     DEFAULT_README = 'README.md'
-    DEFAULT_FILES = ['*']
+    DEFAULT_FILES = ['*', '!.git/', '!.env']
 
     def __init__(self, *, version: str | None = None, readme_file: str | None = None,
                  files: list[str] | None = None):
@@ -118,6 +118,9 @@ class TDKConfig:
             files=data.get('files', cls.DEFAULT_FILES),
         )
 
+    def use_default_files(self):
+        self.files = self.DEFAULT_FILES
+
     def serialize(self):
         return {
             'version': self.version,

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/dsw/tdk/validation.py

@@ -44,7 +44,8 @@ def _validate_extension(field_name: str, value) -> List[ValidationError]:
     if value is not None and re.match(REGEX_ORGANIZATION_ID, value) is None:
         return [ValidationError(
             field_name=field_name,
-            message='File extension should contain only letters, numbers and dots (inside-only)',
+            message='File extension should contain only letters, numbers, '
+                    'and periods (inside-only)',
         )]
     return []
 
@@ -53,7 +54,8 @@ def _validate_organization_id(field_name: str, value) -> List[ValidationError]:
     if value is not None and re.match(REGEX_ORGANIZATION_ID, value) is None:
         return [ValidationError(
             field_name=field_name,
-            message='Organization ID may contain only letters, numbers, and period (inside-only)',
+            message='Organization ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
         )]
     return []
 
@@ -62,7 +64,8 @@ def _validate_template_id(field_name: str, value) -> List[ValidationError]:
     if value is not None and re.match(REGEX_TEMPLATE_ID, value) is None:
         return [ValidationError(
             field_name=field_name,
-            message='Template ID may contain only letters, numbers, and dash (inside-only)',
+            message='Template ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
         )]
     return []
 
@@ -71,7 +74,8 @@ def _validate_km_id(field_name: str, value) -> List[ValidationError]:
     if value is not None and re.match(REGEX_KM_ID, value) is None:
         return [ValidationError(
             field_name=field_name,
-            message='KM ID may contain only letters, numbers, and dash (inside-only)',
+            message='KM ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
         )]
     return []
 
@@ -107,7 +111,7 @@ def _validate_package_id(field_name: str, value: str) -> List[ValidationError]:
     if len(parts) != 3:
         res.append(ValidationError(
             field_name=field_name,
-            message='Package ID is not valid (only {len(parts)} parts)',
+            message=f'Package ID is not valid (only {len(parts)} parts)',
         ))
     if re.match(REGEX_ORGANIZATION_ID, parts[0]) is None:
         res.append(ValidationError(

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0/dsw_tdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dsw-tdk
-Version: 4.16.0
+Version: 4.17.0
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -32,6 +32,7 @@ Requires-Dist: python-slugify
 Requires-Dist: watchfiles
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
 
 # dsw-tdk
 

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'dsw-tdk'
-version = "4.16.0"
+version = "4.17.0"
 description = 'Data Stewardship Wizard Template Development Toolkit'
 readme = 'README.md'
 keywords = ['documents', 'dsw', 'jinja2', 'template', 'toolkit']

{dsw_tdk-4.16.0 → dsw_tdk-4.17.0}/tests/test_cmd_verify.py

@@ -38,8 +38,8 @@ def test_verify_invalid(fixtures_path: pathlib.Path):
     result = runner.invoke(main, args=['verify', template_path.as_posix()])
     assert result.exit_code == 0
     assert 'The template is invalid!' in result.output
-    assert 'template_id: Template ID may contain only letters, numbers, and dash' in result.output
-    assert 'organization_id: Organization ID may contain only letters, numbers, and period' in result.output
+    assert 'template_id: Template ID may contain only letters, numbers,' in result.output
+    assert 'organization_id: Organization ID may contain only letters, numbers,' in result.output
     assert 'version: Version must be in semver format' in result.output
     assert 'name: Missing but it is required' in result.output
     assert 'description: Missing but it is required' in result.output