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

dsw/tdk/validation.py

@@ -0,0 +1,290 @@
+import re
+
+from . import consts
+from .model import Format, PackageFilter, Step
+
+
+class ValidationError(BaseException):
+    def __init__(self, field_name: str, message: str):
+        self.field_name = field_name
+        self.message = message
+
+
+def _validate_required(field_name: str, value) -> list[ValidationError]:
+    if value is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='Missing but it is required',
+        )]
+    return []
+
+
+def _validate_non_empty(field_name: str, value) -> list[ValidationError]:
+    if value is not None and len(value.strip()) == 0:
+        return [ValidationError(
+            field_name=field_name,
+            message='Cannot be empty or only-whitespace',
+        )]
+    return []
+
+
+def _validate_content_type(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_MIME_TYPE, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='Content type should be valid IANA media type',
+        )]
+    return []
+
+
+def _validate_extension(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_ORGANIZATION_ID, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='File extension should contain only letters, numbers, '
+                    'and periods (inside-only)',
+        )]
+    return []
+
+
+def _validate_organization_id(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_ORGANIZATION_ID, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='Organization ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
+        )]
+    return []
+
+
+def _validate_template_id(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_TEMPLATE_ID, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='Template ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
+        )]
+    return []
+
+
+def _validate_km_id(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_KM_ID, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='KM ID may contain only letters, numbers, '
+                    'periods, dashes, and underscores',
+        )]
+    return []
+
+
+def _validate_version(field_name: str, value) -> list[ValidationError]:
+    if value is not None and re.match(consts.REGEX_SEMVER, value) is None:
+        return [ValidationError(
+            field_name=field_name,
+            message='Version must be in semver format <NUM>.<NUM>.<NUM>',
+        )]
+    return []
+
+
+def _validate_natural(field_name: str, value) -> list[ValidationError]:
+    if value is not None and (not isinstance(value, int) or value < 1):
+        return [ValidationError(
+            field_name=field_name,
+            message='It must be positive integer',
+        )]
+    return []
+
+
+def _validate_metamodel_version(field_name: str, value) -> list[ValidationError]:
+    if isinstance(value, int) and value > 0:
+        return []
+    if isinstance(value, str) and '.' in value:
+        parts = value.split('.')
+        if len(parts) != 2:
+            return [ValidationError(
+                field_name=field_name,
+                message='It must be in format <MAJOR>.<MINOR>',
+            )]
+        try:
+            major = int(parts[0])
+            minor = int(parts[1])
+            if major < 1 or minor < 0:
+                return [ValidationError(
+                    field_name=field_name,
+                    message='It must be in format <MAJOR>.<MINOR> '
+                            'with MAJOR >= 1 and MINOR >= 0',
+                )]
+            return []
+        except ValueError:
+            return [ValidationError(
+                field_name=field_name,
+                message='It must be in format <MAJOR>.<MINOR> '
+                        'with MAJOR >= 1 and MINOR >= 0',
+            )]
+    return [ValidationError(
+        field_name=field_name,
+        message='It must be a positive integer or in format <MAJOR>.<MINOR>',
+    )]
+
+
+def _validate_package_id(field_name: str, value: str) -> list[ValidationError]:
+    res = []
+    if value is None:
+        return res
+    if not isinstance(value, str):
+        return [ValidationError(
+            field_name=field_name,
+            message='Package ID is not a string',
+        )]
+    parts = value.split(':')
+    if len(parts) != 3:
+        res.append(ValidationError(
+            field_name=field_name,
+            message=f'Package ID is not valid (only {len(parts)} parts)',
+        ))
+    if re.match(consts.REGEX_ORGANIZATION_ID, parts[0]) is None:
+        res.append(ValidationError(
+            field_name=field_name,
+            message='Package ID contains invalid organization id',
+        ))
+    if re.match(consts.REGEX_KM_ID, parts[1]) is None:
+        res.append(ValidationError(
+            field_name=field_name,
+            message='Package ID contains invalid KM id',
+        ))
+    if re.match(consts.REGEX_SEMVER, parts[2]) is None:
+        res.append(ValidationError(
+            field_name=field_name,
+            message='Package ID contains invalid version',
+        ))
+    return res
+
+
+def _validate_jinja_options(field_name: str, value: dict[str, str]) -> list[ValidationError]:
+    res = []
+    if value is None:
+        return res
+    for k in ('template', 'content-type', 'extension'):
+        if k not in value:
+            res.append(ValidationError(
+                field_name=field_name,
+                message='Jinja option cannot be left out',
+            ))
+        elif value[k] is None or not isinstance(value[k], str) or len(value[k]) == 0:
+            res.append(ValidationError(
+                field_name=field_name,
+                message='Jinja option cannot be empty',
+            ))
+    if 'content-type' in value:
+        res.extend(_validate_content_type(
+            field_name=f'{field_name}.content-type',
+            value=value['content-type'],
+        ))
+    return res
+
+
+class GenericValidator:
+
+    def __init__(self, rules):
+        self.rules = rules
+
+    def validate_field(self, entity, field_name: str):
+        for validator in self.rules.get(field_name, []):
+            err = validator(field_name, getattr(entity, field_name))
+            if len(err) != 0:
+                raise err[0]
+
+    def validate(self, entity, field_name_prefix: str = ''):
+        for field_name, validators in self.rules.items():
+            if field_name.startswith('__'):
+                continue
+            for validator in validators:
+                err = validator(field_name_prefix + field_name, getattr(entity, field_name))
+                if len(err) != 0:
+                    raise err[0]
+        if '__all' in self.rules:
+            err = self.rules['__all'](field_name_prefix, entity)
+            if len(err) != 0:
+                raise err[0]
+
+    def collect_errors(self, entity, field_name_prefix: str = '') -> list[ValidationError]:
+        result = []
+        for field_name, validators in self.rules.items():
+            if field_name.startswith('__'):
+                continue
+            for validator in validators:
+                result.extend(validator(
+                    field_name=f'{field_name_prefix}{field_name}',
+                    value=getattr(entity, field_name),
+                ))
+        if '__all' in self.rules:
+            result.extend(self.rules['__all'](field_name_prefix, entity))
+        return result
+
+
+PackageFilterValidator = GenericValidator({
+    'organization_id': [_validate_organization_id],
+    'km_id': [_validate_km_id],
+    'min_version': [_validate_version],
+    'max_version': [_validate_version],
+})
+
+
+def _validate_package_filters(field_name: str, value: list[PackageFilter]) -> list[ValidationError]:
+    res = []
+    for v in value:
+        res.extend(PackageFilterValidator.collect_errors(v, field_name_prefix=f'{field_name}.'))
+    return res
+
+
+def _validate_step(field_name_prefix: str, value: Step) -> list[ValidationError]:
+    if value.name == 'jinja':
+        return _validate_jinja_options(f'{field_name_prefix}options', value.options)
+    return []
+
+
+StepValidator = GenericValidator({
+    'name': [_validate_non_empty],
+    'options': [],
+    '__all': _validate_step,
+})
+
+
+def _validate_steps(field_name: str, value: list[Step]) -> list[ValidationError]:
+    res = []
+    for v in value:
+        res.extend(StepValidator.collect_errors(v, field_name_prefix=f'{field_name}.'))
+    return res
+
+
+FormatValidator = GenericValidator({
+    'uuid': [_validate_required, _validate_non_empty],
+    'name': [_validate_required, _validate_non_empty],
+    'icon': [_validate_required, _validate_non_empty],
+    'steps': [_validate_required, _validate_steps],
+})
+
+
+def _validate_formats(field_name: str, value: list[Format]) -> list[ValidationError]:
+    res = []
+    uuids = set()
+    for v in value:
+        if v.uuid in uuids:
+            res.append(ValidationError(field_name, f'Duplicate format UUID {v.uuid}'))
+        uuids.add(v.uuid)
+        res.extend(FormatValidator.collect_errors(v, field_name_prefix=f'{field_name}.'))
+    return res
+
+
+TemplateValidator = GenericValidator({
+    'template_id': [_validate_required, _validate_template_id],
+    'organization_id': [_validate_required, _validate_organization_id],
+    'version': [_validate_required, _validate_version],
+    'name': [_validate_required, _validate_non_empty],
+    'description': [_validate_required, _validate_non_empty],
+    'readme': [_validate_required, _validate_non_empty],
+    'license': [_validate_required, _validate_non_empty],
+    'metamodel_version': [_validate_metamodel_version, _validate_required],
+    'allowed_packages': [_validate_package_filters],
+    'formats': [_validate_required, _validate_formats],
+})

{dsw_tdk-3.13.0.dist-info → dsw_tdk-4.27.0.dist-info}/METADATA

@@ -1,50 +1,49 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: dsw-tdk
-Version: 3.13.0
+Version: 4.27.0
 Summary: Data Stewardship Wizard Template Development Toolkit
-Home-page: https://github.com/ds-wizard/dsw-tdk
+Keywords: documents,dsw,jinja2,template,toolkit
 Author: Marek Suchánek
-Author-email: marek.suchanek@ds-wizard.org
-License: Apache-2.0
-Keywords: dsw template toolkit jinja documents
-Platform: UNKNOWN
+Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
+License: Apache License 2.0
 Classifier: Framework :: AsyncIO
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
-Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
 Classifier: Topic :: Utilities
-Requires-Python: >=3.6, <4
-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: watchgod
+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
+Description-Content-Type: text/markdown
 
 # dsw-tdk
 
 [![User Guide](https://img.shields.io/badge/docs-User%20Guide-informational)](https://guide.ds-wizard.org)
-[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ds-wizard/dsw-tdk)](https://github.com/ds-wizard/dsw-tdk/releases)
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ds-wizard/engine-tools)](https://github.com/ds-wizard/engine-tools/releases)
 [![PyPI](https://img.shields.io/pypi/v/dsw-tdk)](https://pypi.org/project/dsw-tdk/)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6c98735aecb144abaaee19361d7c8976)](https://www.codacy.com/gh/ds-wizard/dsw-tdk/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=ds-wizard/dsw-tdk&amp;utm_campaign=Badge_Grade)
-[![DSW TDK CI](https://github.com/ds-wizard/dsw-tdk/workflows/DSW%20TDK%20CI/badge.svg)](https://github.com/ds-wizard/dsw-tdk/actions)
 [![Docker Pulls](https://img.shields.io/docker/pulls/datastewardshipwizard/dsw-tdk)](https://hub.docker.com/r/datastewardshipwizard/dsw-tdk)
-[![LICENSE](https://img.shields.io/github/license/ds-wizard/dsw-tdk)](LICENSE)
+[![LICENSE](https://img.shields.io/github/license/ds-wizard/engine-tools)](LICENSE)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4975/badge)](https://bestpractices.coreinfrastructure.org/projects/4975)
+[![Python Version](https://img.shields.io/badge/Python-%E2%89%A5%203.7-blue)](https://python.org)
 
 *Template Development Kit for [Data Stewardship Wizard](https://ds-wizard.org)*
 
@@ -102,12 +101,10 @@ For further information, visit our [documentation](https://docs.ds-wizard.org).
 
 You can use the following environment variables to avoid repeating CLI options.
 
-- `DSW_API` = URL of DSW API you want to use, e.g., https://api.demo.ds-wizard.org (notice that it is **not** the URL of client, you can find it out by clicking Help > About in DSW)
-    - Used when `--api-server` not specified
-- `DSW_USERNAME` = username (email address) that you use to login with your admin account
-    - Used when `--username` not specified
-- `DSW_PASSWORD` = corresponding password to login with your admin account
-    - Used when `--password` not specified
+- `DSW_API_URL` = URL of DSW API you want to use, e.g., https://api.demo.ds-wizard.org (notice that it is **not** the URL of client, you can find it out by clicking Help > About in DSW)
+    - Used when `--api-url` not specified
+- `DSW_API_KEY` = API Key of the user authorized to manage document templates
+    - Used when `--api-key` not specified
   
  You can also use them in `.env` file which is automatically loaded from current directory or specify it using `--dot-env` option:
  
@@ -138,7 +135,7 @@ $ dsw-tdk --debug list
 
 ## Requirements
 
--  [Python 3.7+](https://www.python.org/downloads/)
+-  [Python 3.8+](https://www.python.org/downloads/)
 -  DSW instance with matching version (e.g. a local one using [Docker](https://github.com/ds-wizard/dsw-deployment-example))
 -  Admin credentials (email+password) to the DSW instance
 
@@ -155,5 +152,3 @@ For more information read [CONTRIBUTING](CONTRIBUTING.md).
 ## License
 
 This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for more details.
-
-

dsw_tdk-4.27.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+dsw/tdk/__init__.py,sha256=ofVgqzsHfzERknIDuS08mjNh6cCbchLcrbuYEtJBUl0,291
+dsw/tdk/__main__.py,sha256=7atdpOyr41OPmApZ4ktsGSF31GSIfEY9xOBzJZ-azYQ,85
+dsw/tdk/api_client.py,sha256=TBVzMNvOARPvRfFIOP9IXytkAeY6uovegfN9W1lCOzM,15377
+dsw/tdk/build_info.py,sha256=StkP0pJCmLTOw9Bgu2hzdlQFIe6WTZkXtOP8HsXUjDw,381
+dsw/tdk/cli.py,sha256=6Cu1movV2_LkA-pNTQB1dSREYqTNOnArqPiJIusQ9Do,28137
+dsw/tdk/config.py,sha256=4G2VfJ2DIm-NLQdtCHg6y_cEi0tDf9m6mbAgqEGeNeY,4782
+dsw/tdk/consts.py,sha256=f2tztF4m7s4mbj3qNH3uHpAgEOFIK_fzwZerIhtv814,714
+dsw/tdk/core.py,sha256=7DC63ohGZ6ZZhuk3XjqH6NUHFvrg-hANSRlYmfI-wLA,27457
+dsw/tdk/model.py,sha256=tJZnrQE88dXUZZ3b_UbQjeHm1W_qwbCeqscl9IK3r80,17527
+dsw/tdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dsw/tdk/templates/LICENSE.j2,sha256=6WzK06169rxZ4V_boYgejcZkw-1Up_WoU18iI3Gbkfs,60
+dsw/tdk/templates/README.md.j2,sha256=FzUABeMM8To0oT48Kytoox64uAZ8F7FSAAXgpyKzqdU,247
+dsw/tdk/templates/env.j2,sha256=yUaY7ZLbjdG45-_q6KWi-YnX9bjP7_lfXrowhJF1he0,98
+dsw/tdk/templates/starter.j2,sha256=JKJIkiXsmBO4P6pKXM4IvSz3JgJhqCnaZI1NVfPPnXg,246
+dsw/tdk/utils.py,sha256=qTqar4RUqRMvIO_RFyoSgeeTvZy8qmyKLWoE9XoPY9k,5678
+dsw/tdk/validation.py,sha256=KD2smmH2uDBVxx35eczJmYNnzJcq8g8L5LDu1hkbxe0,10088
+dsw_tdk-4.27.0.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+dsw_tdk-4.27.0.dist-info/entry_points.txt,sha256=-55ASKbqu423XqpytOZyuTZSNWus2MsQuFXl2p_nCfc,42
+dsw_tdk-4.27.0.dist-info/METADATA,sha256=pl94tCMYLsQx9VWtQl2424NWAXSogP-mwWKI16EGp9M,6144
+dsw_tdk-4.27.0.dist-info/RECORD,,

{dsw_tdk-3.13.0.dist-info → dsw_tdk-4.27.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: uv 0.9.28
 Root-Is-Purelib: true
 Tag: py3-none-any
-

dsw_tdk-4.27.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+dsw-tdk = dsw.tdk:main
+

dsw_tdk/__main__.py

@@ -1,3 +0,0 @@
-from dsw_tdk.cli import main
-
-main(ctx=None)