dsw-tdk 4.26.1__tar.gz → 4.27.0__tar.gz

{dsw_tdk-4.26.1/dsw_tdk.egg-info → dsw_tdk-4.27.0}/PKG-INFO

@@ -1,13 +1,11 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: dsw-tdk
-Version: 4.26.1
+Version: 4.27.0
 Summary: Data Stewardship Wizard Template Development Toolkit
+Keywords: documents,dsw,jinja2,template,toolkit
+Author: Marek Suchánek
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
-Project-URL: Homepage, https://ds-wizard.org
-Project-URL: Repository, https://github.com/ds-wizard/engine-tools
-Project-URL: Documentation, https://guide.ds-wizard.org
-Keywords: documents,dsw,jinja2,template,toolkit
 Classifier: Framework :: AsyncIO
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
@@ -18,22 +16,24 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: aiohttp
 Requires-Dist: click
 Requires-Dist: colorama
 Requires-Dist: humanize
-Requires-Dist: Jinja2
+Requires-Dist: jinja2
 Requires-Dist: multidict
 Requires-Dist: pathspec
 Requires-Dist: python-dotenv
 Requires-Dist: python-slugify
 Requires-Dist: watchfiles
+Requires-Dist: pytest ; extra == 'test'
+Requires-Python: >=3.10, <4
+Project-URL: Homepage, https://ds-wizard.org
+Project-URL: Repository, https://github.com/ds-wizard/engine-tools
+Project-URL: Documentation, https://guide.ds-wizard.org
+Project-URL: Issues, https://github.com/ds-wizard/ds-wizard/issues
 Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Dynamic: license-file
+Description-Content-Type: text/markdown
 
 # dsw-tdk
 

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/__init__.py

@@ -6,10 +6,11 @@ Template Development Kit for `Data Stewardship Wizard`_.
    https://ds-wizard.org
 
 """
+from . import consts
 from .cli import main
-from .consts import APP, VERSION
 
-__app__ = APP
-__version__ = VERSION
+
+__app__ = consts.APP
+__version__ = consts.VERSION
 
 __all__ = ['__app__', '__version__', 'main']

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/__main__.py

@@ -1,4 +1,5 @@
 from .cli import main
 
+
 # pylint: disable-next=no-value-for-parameter
 main(ctx=None)

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/api_client.py

@@ -5,7 +5,7 @@ import urllib.parse
 import aiohttp
 import aiohttp.client_exceptions
 
-from .consts import DEFAULT_ENCODING, APP, VERSION
+from . import consts
 from .model import Template, TemplateFile, TemplateFileType
 
 
@@ -34,27 +34,27 @@ def handle_client_errors(func):
         except aiohttp.client_exceptions.ContentTypeError as e:
             raise WizardCommunicationError(
                 reason='Unexpected response type',
-                message=e.message
+                message=e.message,
             ) from e
         except aiohttp.client_exceptions.ClientResponseError as e:
             raise WizardCommunicationError(
                 reason='Error response status',
-                message=f'Server responded with error HTTP status {e.status}: {e.message}'
+                message=f'Server responded with error HTTP status {e.status}: {e.message}',
             ) from e
         except aiohttp.client_exceptions.InvalidURL as e:
             raise WizardCommunicationError(
                 reason='Invalid URL',
-                message=f'Provided API URL seems invalid: {e.url}'
+                message=f'Provided API URL seems invalid: {e.url}',
             ) from e
         except aiohttp.client_exceptions.ClientConnectorError as e:
             raise WizardCommunicationError(
                 reason='Server unreachable',
-                message=f'Desired server is not reachable (errno {e.os_error.errno})'
+                message=f'Desired server is not reachable (errno {e.os_error.errno})',
             ) from e
         except Exception as e:
             raise WizardCommunicationError(
                 reason='Communication error',
-                message=f'Communication with server failed ({e})'
+                message=f'Communication with server failed ({e})',
             ) from e
     return handled_client_call
 
@@ -65,7 +65,7 @@ class WizardAPIClient:
     def _headers(self, extra=None):
         headers = {
             'Authorization': f'Bearer {self.token}',
-            'User-Agent': f'{APP}/{VERSION}'
+            'User-Agent': f'{consts.APP}/{consts.VERSION}',
         }
         if extra is not None:
             headers.update(extra)
@@ -78,7 +78,7 @@ class WizardAPIClient:
             raise WizardCommunicationError(
                 reason='Unexpected response status',
                 message=f'Server responded with unexpected HTTP status {r.status}: '
-                        f'{r.reason} (expecting {expected_status})'
+                        f'{r.reason} (expecting {expected_status})',
             )
 
     def __init__(self, api_url: str, api_key: str, session=None):
@@ -158,11 +158,11 @@ class WizardAPIClient:
     async def login(self, email: str, password: str) -> str | None:
         req = {'email': email, 'password': password}
         body = await self._post_json('/tokens', json=req)
-        token_value = body.get('token', None)
+        token_value = body.get('token')
         if not isinstance(token_value, str):
             raise WizardCommunicationError(
                 reason='Invalid response',
-                message='Server did not return a valid token'
+                message='Server did not return a valid token',
             )
         self.token = token_value
         return self.token
@@ -263,7 +263,7 @@ class WizardAPIClient:
             raise RuntimeError('Organization ID changed during the process')
         body = await self._put_json(
             endpoint=f'/document-template-drafts/{remote_id}',
-            json=template.serialize_for_update()
+            json=template.serialize_for_update(),
         )
         return _load_remote_template(body)
 
@@ -281,8 +281,8 @@ class WizardAPIClient:
             endpoint=f'/document-template-drafts/{remote_id}/files',
             json={
                 'fileName': file.filename.as_posix(),
-                'content': file.content.decode(DEFAULT_ENCODING)
-            }
+                'content': file.content.decode(consts.DEFAULT_ENCODING),
+            },
         )
         return _load_remote_file(data)
 
@@ -338,7 +338,7 @@ class WizardAPIClient:
                 f'{self.api_url}/document-template-drafts/{remote_id}'
                 f'/assets/{file.remote_id}/content',
                 data=data,
-                headers=self._headers()
+                headers=self._headers(),
         ) as r:
             self._check_status(r, expected_status=200)
             body = await r.json()
@@ -363,15 +363,15 @@ class WizardAPIClient:
     @handle_client_errors
     async def get_api_version(self) -> tuple[str, str | None]:
         body = await self._get_json('/')
-        version = body.get('version', None)
+        version = body.get('version')
         metamodel_version = None
         for item in body.get('metamodelVersions', []):
             if item.get('name', '') == 'Document Template':
-                metamodel_version = item.get('version', None)
+                metamodel_version = item.get('version')
         if version is None:
             raise WizardCommunicationError(
                 reason='Invalid response',
-                message='Server did not return valid API version information (incompatible TDK?)'
+                message='Server did not return valid API version information (incompatible TDK?)',
             )
         return version, metamodel_version
 
@@ -384,25 +384,23 @@ class WizardAPIClient:
 def _load_remote_file(data: dict) -> TemplateFile:
     content: str = data.get('content', '')
     filename: str = str(data.get('fileName', ''))
-    file = TemplateFile(
-        remote_id=data.get('uuid', None),
+    return TemplateFile(
+        remote_id=data.get('uuid'),
         remote_type=TemplateFileType.FILE,
         filename=pathlib.Path(urllib.parse.unquote(filename)),
-        content=content.encode(encoding=DEFAULT_ENCODING),
+        content=content.encode(encoding=consts.DEFAULT_ENCODING),
     )
-    return file
 
 
 def _load_remote_asset(data: dict, content: bytes) -> TemplateFile:
     filename = str(data.get('fileName', ''))
-    asset = TemplateFile(
-        remote_id=data.get('uuid', None),
+    return TemplateFile(
+        remote_id=data.get('uuid'),
         remote_type=TemplateFileType.ASSET,
         filename=pathlib.Path(urllib.parse.unquote(filename)),
-        content_type=data.get('contentType', None),
+        content_type=data.get('contentType'),
         content=content,
     )
-    return asset
 
 
 def _load_remote_template(data: dict) -> Template:

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v4.26.1~2e1c502',
-    built_at='2026-01-10 17:15:33Z',
-    sha='2e1c502c11e1e2fd885a1c696488008a1ca9b343',
+    version='v4.27.0~8ec71bd',
+    built_at='2026-02-03 08:45:12Z',
+    sha='8ec71bd85dfbea66adedb6590f7d76ae5143bbaa',
     branch='HEAD',
-    tag='v4.26.1',
+    tag='v4.27.0',
 )

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/cli.py

@@ -12,14 +12,15 @@ import humanize
 import slugify
 import watchfiles
 
+from . import consts
 from .api_client import WizardCommunicationError
 from .config import CONFIG
-from .consts import VERSION, DEFAULT_LIST_FORMAT, DEFAULT_ENCODING
 from .core import TDKCore, TDKProcessingError
 from .model import Template
-from .utils import TemplateBuilder, FormatSpec, safe_utf8, create_dot_env
+from .utils import FormatSpec, TemplateBuilder, create_dot_env, safe_utf8
 from .validation import ValidationError
 
+
 CURRENT_DIR = pathlib.Path.cwd()
 DIR_TYPE = click.Path(exists=True, dir_okay=True, file_okay=False, resolve_path=True,
                       readable=True, writable=True)
@@ -29,6 +30,10 @@ NEW_DIR_TYPE = click.Path(dir_okay=True, file_okay=False, resolve_path=True,
                           readable=True, writable=True)
 
 
+def _now() -> datetime.datetime:
+    return datetime.datetime.now(tz=datetime.UTC)
+
+
 class ClickPrinter:
 
     CHANGE_SIGNS = {
@@ -64,7 +69,7 @@ class ClickPrinter:
     @classmethod
     def watch_change(cls, change_type: watchfiles.Change, filepath: pathlib.Path,
                      root: pathlib.Path):
-        timestamp = datetime.datetime.now().isoformat(timespec='milliseconds')
+        timestamp = _now().isoformat(timespec='milliseconds')
         sign = cls.CHANGE_SIGNS[change_type]
         click.secho('WATCH', fg='blue', bold=True, nl=False)
         click.echo(f'@{timestamp} {sign} {filepath.relative_to(root)}')
@@ -149,7 +154,7 @@ class ClickLogger(logging.Logger):
 
     def _print_message(self, level, message):
         if self.show_timestamp:
-            timestamp = datetime.datetime.now().isoformat(timespec='milliseconds')
+            timestamp = _now().isoformat(timespec='milliseconds')
             click.echo(timestamp + ' | ', nl=False)
         if self.show_level:
             sep = ' | ' if self.show_timestamp else ': '
@@ -204,7 +209,7 @@ def interact_formats() -> dict[str, FormatSpec]:
         format_spec = FormatSpec()
         prompt_fill('Format name', obj=format_spec, attr='name', default='HTML')
         if format_spec.name not in formats or click.confirm(
-                'There is already a format with this name. Do you want to change it?'
+                'There is already a format with this name. Do you want to change it?',
         ):
             prompt_fill('File extension', obj=format_spec, attr='file_extension',
                         default=format_spec.name.lower() if ' ' not in format_spec.name else None)
@@ -267,7 +272,7 @@ def dir_from_id(template_id: str) -> pathlib.Path:
               help='Hide additional information logs.')
 @click.option('--debug', is_flag=True,
               help='Enable debug logging.')
-@click.version_option(version=VERSION)
+@click.version_option(version=consts.VERSION)
 @click.pass_context
 def main(ctx, quiet, debug, dot_env, environment, no_dot_env, no_config):
     if not no_config:
@@ -499,7 +504,7 @@ def extract_package(ctx, template_package, output, force: bool):
               help='URL of Wizard server API.')
 @click.option('-k', '--api-key', metavar='API-KEY', envvar='DSW_API_KEY',
               help='API key for Wizard instance.')
-@click.option('--output-format', default=DEFAULT_LIST_FORMAT,
+@click.option('--output-format', default=consts.DEFAULT_LIST_FORMAT,
               metavar='FORMAT', help='Entry format string for printing.')
 @click.option('-r', '--released-only', is_flag=True, help='List only released templates')
 @click.option('-d', '--drafts-only', is_flag=True, help='List only template drafts')
@@ -652,7 +657,7 @@ def config_check():
         else:
             env_out = click.style(env_name, fg='blue', bold=True)
             click.echo(env_out)
-        click.echo(f'  API URL: {env.api_url if env.api_url else not_set}')
+        click.echo(f'  API URL: {env.api_url or not_set}')
         click.echo(f'  API Key: {hidden if env.api_key else not_set}')
     click.echo('')
     click.secho('Project-local configuration:', bold=True)
@@ -687,7 +692,7 @@ def config_create_dotenv(ctx, template_dir, api_url, api_key, force):
     try:
         if output.exists():
             if force:
-                ClickPrinter.warning(f'Overwriting {output.as_posix()} (forced)', )
+                ClickPrinter.warning(f'Overwriting {output.as_posix()} (forced)')
             else:
                 raise FileExistsError(f'File {output.as_posix()} already exists (not forced)')
         output.write_text(
@@ -695,7 +700,7 @@ def config_create_dotenv(ctx, template_dir, api_url, api_key, force):
                 api_url=CONFIG.env.api_url,
                 api_key=CONFIG.env.api_key,
             ),
-            encoding=DEFAULT_ENCODING,
+            encoding=consts.DEFAULT_ENCODING,
         )
     except Exception as e:
         ClickPrinter.failure('Failed to create dot-env file')

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/config.py

@@ -5,7 +5,7 @@ import pathlib
 
 import dotenv
 
-from .consts import DEFAULT_ENCODING
+from . import consts
 
 
 def _rectify_api_url(api_url: str | None) -> str:
@@ -44,11 +44,8 @@ class TDKConfig:
         self.default_env_name = None  # type: str | None
 
     def load_dotenv(self, path: pathlib.Path):
-        try:
-            if path.exists():
-                dotenv.load_dotenv(path)
-        except Exception as e:
-            print(f"Error loading .env file: {e}")
+        if path.exists():
+            dotenv.load_dotenv(path)
         api_url = os.getenv('DSW_API_URL', '')
         api_key = os.getenv('DSW_API_KEY', '')
 
@@ -147,8 +144,8 @@ class TDKConfig:
             config.set(section_name, 'api_url', env.api_url)
             config.set(section_name, 'api_key', env.api_key)
 
-        with open(output, 'w', encoding=DEFAULT_ENCODING) as configfile:
-            config.write(configfile)
+        with output.open(mode='w', encoding=consts.DEFAULT_ENCODING) as config_file:
+            config.write(config_file)
 
 
 CONFIG = TDKConfig()

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/consts.py

@@ -3,8 +3,9 @@ import re
 
 import pathspec
 
+
 APP = 'dsw-tdk'
-VERSION = '4.26.1'
+VERSION = '4.27.0'
 METAMODEL_VERSION_MAJOR = 17
 METAMODEL_VERSION_MINOR = 1
 METAMODEL_VERSION = f'{METAMODEL_VERSION_MAJOR}.{METAMODEL_VERSION_MINOR}'

{dsw_tdk-4.26.1 → dsw_tdk-4.27.0}/dsw/tdk/core.py

@@ -10,11 +10,11 @@ import zipfile
 
 import watchfiles
 
+from . import consts
 from .api_client import WizardAPIClient, WizardCommunicationError
-from .consts import DEFAULT_ENCODING
-from .model import TemplateProject, Template, TemplateFile, TemplateFileType
+from .model import Template, TemplateFile, TemplateFileType, TemplateProject
 from .utils import UUIDGen
-from .validation import ValidationError, TemplateValidator
+from .validation import TemplateValidator, ValidationError
 
 
 ChangeItem = tuple[watchfiles.Change, pathlib.Path]
@@ -65,7 +65,8 @@ class TDKCore:
                                 'but still compatible', mm_ver, mmr_ver)
         else:
             raise TDKProcessingError(
-                f'Unsupported metamodel version: local {mm_ver}, remote {mmr_ver}', hint
+                f'Unsupported metamodel version: local {mm_ver}, remote {mmr_ver}',
+                hint,
             )
 
     def __init__(self, template: Template | None = None, project: TemplateProject | None = None,
@@ -155,8 +156,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()
+        if self.project.template is None:
+            raise RuntimeError('No template is loaded in the project')
+        if len(self.project.safe_template.tdk_config.files) == 0:
+            self.project.safe_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)
@@ -264,14 +267,14 @@ class TDKCore:
 
     async def cleanup_remote_files(self, remote_assets: list[TemplateFile],
                                    remote_files: list[TemplateFile]):
-        for file in self.safe_project.safe_template.files.values():
-            self.logger.debug('Cleaning up remote %s', file.filename.as_posix())
-            for asset in remote_assets:
-                if asset.filename == file.filename:
-                    await self._delete_template_file(file=asset, project_update=False)
-            for file in remote_files:
-                if file.filename == file.filename:
-                    await self._delete_template_file(file=file, project_update=False)
+        for local_file in self.safe_project.safe_template.files.values():
+            self.logger.debug('Cleaning up remote %s', local_file.filename.as_posix())
+            for remote_asset in remote_assets:
+                if remote_asset.filename == local_file.filename:
+                    await self._delete_template_file(file=remote_asset, project_update=False)
+            for remote_file in remote_files:
+                if remote_file.filename == local_file.filename:
+                    await self._delete_template_file(file=remote_file, project_update=False)
 
     async def _create_template_file(self, file: TemplateFile, project_update: bool = False):
         try:
@@ -318,7 +321,7 @@ class TDKCore:
                     self.logger.info('Adding template file %s', file.filename.as_posix())
                     files.append({
                         'uuid': str(UUIDGen.generate()),
-                        'content': file.content.decode(encoding=DEFAULT_ENCODING),
+                        'content': file.content.decode(encoding=consts.DEFAULT_ENCODING),
                         'fileName': str(file.filename.as_posix()),
                     })
                 else:
@@ -359,7 +362,7 @@ class TDKCore:
             self.logger.debug('Extracting template data')
             if not file.exists():
                 raise RuntimeError('Malformed package: missing template.json file')
-            data = json.loads(file.read_text(encoding=DEFAULT_ENCODING))
+            data = json.loads(file.read_text(encoding=consts.DEFAULT_ENCODING))
             template = Template.load_local(data)
             template.tdk_config.use_default_files()
             self.logger.warning('Using default _tdk.files in template.json, you may want '
@@ -377,13 +380,13 @@ class TDKCore:
             local_template_json = template_dir / 'template.json'
             local_template_json.write_text(
                 data=json.dumps(template.serialize_local_new(), indent=2),
-                encoding=DEFAULT_ENCODING,
+                encoding=consts.DEFAULT_ENCODING,
             )
             self.logger.debug('Extracting README.md from package')
             local_readme = template_dir / 'README.md'
             local_readme.write_text(
                 data=data['readme'].replace('\r\n', '\n'),
-                encoding=DEFAULT_ENCODING,
+                encoding=consts.DEFAULT_ENCODING,
             )
             self.logger.debug('Extracting assets from package')
             for asset_file in assets_dir.rglob('*'):
@@ -399,7 +402,7 @@ class TDKCore:
                 target_file = template_dir / filename
                 target_dir = target_file.parent
                 target_dir.mkdir(parents=True, exist_ok=True)
-                target_file.write_text(data=content, encoding=DEFAULT_ENCODING)
+                target_file.write_text(data=content, encoding=consts.DEFAULT_ENCODING)
         self.logger.debug('Extracting package done')
 
     async def watch_project(self, callback, stop_event: asyncio.Event):
@@ -407,12 +410,14 @@ class TDKCore:
                 self.safe_project.template_dir,
                 stop_event=stop_event,
         ):
-            await callback((
+            await callback(
                 change for change in ((change[0], pathlib.Path(change[1])) for change in changes)
                 if self.safe_project.is_template_file(
-                    change[1], include_descriptor=True, include_readme=True
+                    change[1],
+                    include_descriptor=True,
+                    include_readme=True,
                 )
-            ))
+            )
 
     async def update_descriptor(self):
         try: