dsw-tdk 3.22.1__py2.py3-none-any.whl → 3.24.0__py2.py3-none-any.whl

dsw/tdk/api_client.py

@@ -91,7 +91,7 @@ class DSWAPIClient:
         """
         self.api_url = api_url
         self.token = None
-        self.session = session or aiohttp.ClientSession(connector=aiohttp.TCPConnector(verify_ssl=False))
+        self.session = session or aiohttp.ClientSession(connector=aiohttp.TCPConnector(ssl=False))
 
     @property
     def templates_endpoint(self):
@@ -142,6 +142,10 @@ class DSWAPIClient:
         self.token = body.get('token', None)
         return self.token
 
+    @handle_client_errors
+    async def get_current_user(self) -> dict:
+        return await self._get_json('/users/current')
+
     @handle_client_errors
     async def check_template_exists(self, remote_id: str) -> bool:
         async with self.session.get(f'{self.templates_endpoint}/{remote_id}', headers=self._headers()) as r:

dsw/tdk/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v3.22.1~f58badd',
-    built_at='2023-04-14 12:55:45Z',
-    sha='f58badda4c93b654651aedd46e082f1d756eb2aa',
+    version='v3.24.0~de1a777',
+    built_at='2023-05-31 09:42:09Z',
+    sha='de1a777fb9287f666e161e98200054ae757fa44c',
     branch='HEAD',
-    tag='v3.22.1',
+    tag='v3.24.0',
 )

dsw/tdk/cli.py

@@ -1,4 +1,6 @@
 import asyncio
+import sys
+
 import click  # type: ignore
 import datetime
 import dotenv
@@ -39,6 +41,11 @@ class ClickPrinter:
     def error(message: str, **kwargs):
         click.secho(message=message, err=True, fg='red', **kwargs)
 
+    @staticmethod
+    def warning(message: str, **kwargs):
+        click.secho('WARNING', fg='yellow', bold=True, nl=False)
+        click.echo(f': {message}')
+
     @staticmethod
     def success(message: str):
         click.secho('SUCCESS', fg='green', bold=True, nl=False)
@@ -171,6 +178,37 @@ class CLIContext:
         self.logger.muted = True
 
 
+class APICredentials:
+
+    def __init__(self, username, password, api_key):
+        self.username = username
+        self.password = password
+        self.api_key = api_key
+
+    def check(self):
+        if self.api_key is not None:
+            return
+        if self.username is not None and self.password is not None:
+            ClickPrinter.warning('Using username/password credentials, '
+                                 'consider switching to API keys.')
+            ClickPrinter.warning('Username/password authentication will be '
+                                 'removed in 3.25 as deprecated.')
+            return False
+        ClickPrinter.failure('Invalid credentials entered! You need to provide '
+                             'either API key or username/password credentials.')
+        sys.exit(1)
+
+    def init_args(self):
+        if self.api_key is not None:
+            return {
+                'api_key': self.api_key,
+            }
+        return {
+            'username': self.username,
+            'password': self.password,
+        }
+
+
 def interact_formats() -> Dict[str, FormatSpec]:
     add_format = click.confirm('Do you want to add a format?', default=True)
     formats = dict()  # type: Dict[str, FormatSpec]
@@ -270,21 +308,25 @@ def new_template(ctx, template_dir, force):
 @click.argument('TEMPLATE-DIR', type=NEW_DIR_TYPE, default=None, required=False)
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='EMAIL', help='Admin username (email) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Email', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('-f', '--force', is_flag=True, help='Overwrite any existing files.')
 @click.pass_context
-def get_template(ctx, api_server, template_id, template_dir, username, password, force):
-    template_dir = template_dir or dir_from_id(template_id)
+def get_template(ctx, api_server, template_id, template_dir, username, password, api_key, force):
+    template_dir = pathlib.Path(template_dir or dir_from_id(template_id))
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
 
     async def main_routine():
         tdk = TDKCore(logger=ctx.obj.logger)
         template_type = 'unknown'
         zip_data = None
         try:
-            await tdk.init_client(api_url=api_server, username=username, password=password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             try:
                 await tdk.load_remote(template_id=template_id)
                 template_type = 'draft'
@@ -295,6 +337,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
         except DSWCommunicationError as e:
             ClickPrinter.error('Could not get template:', bold=True)
             ClickPrinter.error(f'> {e.reason}\n> {e.message}')
+            await tdk.safe_client.close()
             exit(1)
         await tdk.safe_client.safe_close()
         if template_type == 'draft':
@@ -305,6 +348,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
             except Exception as e:
                 ClickPrinter.failure('Could not store template locally')
                 ClickPrinter.error(f'> {e}')
+                await tdk.safe_client.close()
                 exit(1)
         elif template_type == 'bundle' and zip_data is not None:
             try:
@@ -313,6 +357,7 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
             except Exception as e:
                 ClickPrinter.failure('Could not store template locally')
                 ClickPrinter.error(f'> {e}')
+                await tdk.safe_client.close()
                 exit(1)
         else:
             ClickPrinter.failure(f'{template_id} is not released nor draft of a document template')
@@ -326,15 +371,19 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
 @click.argument('TEMPLATE-DIR', type=DIR_TYPE, default=CURRENT_DIR, required=False)
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='USERNAME', help='Admin username (email address) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Password', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('-f', '--force', is_flag=True, help='Delete template if already exists.')
 @click.option('-w', '--watch', is_flag=True, help='Enter watch mode to continually upload changes.')
 @click.pass_context
-def put_template(ctx, api_server, template_dir, username, password, force, watch):
+def put_template(ctx, api_server, template_dir, username, password, api_key, force, watch):
     tdk = TDKCore(logger=ctx.obj.logger)
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
 
     async def watch_callback(changes):
         changes = list(changes)
@@ -350,7 +399,7 @@ def put_template(ctx, api_server, template_dir, username, password, force, watch
     async def main_routine():
         load_local(tdk, template_dir)
         try:
-            await tdk.init_client(api_server, username, password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             await tdk.store_remote(force=force)
             ClickPrinter.success(f'Template {tdk.safe_project.safe_template.id} '
                                  f'uploaded to {api_server}')
@@ -409,7 +458,7 @@ def extract_package(ctx, template_package, output, force: bool):
         data = pathlib.Path(template_package).read_bytes()
         tdk.extract_package(
             zip_data=data,
-            template_dir=output,
+            template_dir=pathlib.Path(output),
             force=force,
         )
     except Exception as e:
@@ -422,21 +471,26 @@ def extract_package(ctx, template_package, output, force: bool):
 @main.command(help='List templates from DSW via API.', name='list')
 @click.option('-s', '--api-server', metavar='API-URL', envvar='DSW_API',
               prompt='URL of DSW API', help='URL of DSW server API.', callback=rectify_url)
-@click.option('-u', '--username', envvar='DSW_USERNAME', prompt='Username', hide_input=False,
-              metavar='USERNAME', help='Admin username (email address) for DSW instance.')
-@click.option('-p', '--password', envvar='DSW_PASSWORD', prompt='Password', hide_input=True,
-              metavar='PASSWORD', help='Admin password for DSW instance.')
+@click.option('-u', '--username', envvar='DSW_USERNAME', metavar='EMAIL', default=None,
+              help='Admin username (email) for DSW instance.')
+@click.option('-p', '--password', envvar='DSW_PASSWORD', metavar='PASSWORD', default=None,
+              help='Admin password for DSW instance.')
+@click.option('-k', '--api-key', envvar='DSW_API_KEY', metavar='API-KEY', default=None,
+              help='API key for DSW instance.')
 @click.option('--output-format', default=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')
 @click.pass_context
-def list_templates(ctx, api_server, username, password, output_format: str,
+def list_templates(ctx, api_server, username, password, api_key, output_format: str,
                    released_only: bool, drafts_only: bool):
+    creds = APICredentials(username=username, password=password, api_key=api_key)
+    creds.check()
+
     async def main_routine():
         tdk = TDKCore(logger=ctx.obj.logger)
         try:
-            await tdk.init_client(api_server, username, password)
+            await tdk.init_client(api_url=api_server, **creds.init_args())
             if released_only:
                 templates = await tdk.list_remote_templates()
                 for template in templates:
@@ -454,12 +508,13 @@ def list_templates(ctx, api_server, username, password, output_format: str,
                 drafts = await tdk.list_remote_drafts()
                 for template in drafts:
                     click.echo(output_format.format(template=template))
+            await tdk.safe_client.safe_close()
 
         except DSWCommunicationError as e:
             ClickPrinter.failure('Failed to get list of templates')
             ClickPrinter.error(f'> {e.reason}\n> {e.message}')
+            await tdk.safe_client.safe_close()
             exit(1)
-        await tdk.safe_client.safe_close()
 
     loop = asyncio.get_event_loop()
     loop.run_until_complete(main_routine())

dsw/tdk/consts.py

@@ -3,7 +3,7 @@ import pathspec  # type: ignore
 import re
 
 APP = 'dsw-tdk'
-VERSION = '3.22.0'
+VERSION = '3.24.0'
 METAMODEL_VERSION = 11
 
 REGEX_SEMVER = re.compile(r'^[0-9]+\.[0-9]+\.[0-9]+$')

dsw/tdk/core.py

@@ -99,12 +99,18 @@ class TDKCore:
             raise RuntimeError('No DSW API client specified')
         return self.client
 
-    async def init_client(self, api_url: str, username: str, password: str):
+    async def init_client(self, api_url: str, username: Optional[str] = None,
+                          password: Optional[str] = None, api_key: Optional[str] = None):
         self.logger.info(f'Connecting to {api_url}')
         self.client = DSWAPIClient(api_url=api_url)
-        await self.client.login(email=username, password=password)
+        if api_key is not None:
+            self.client.token = api_key  # type: ignore
+        if username is not None and password is not None:
+            await self.client.login(email=username, password=password)
         self.remote_version = await self.client.get_api_version()
-        self.logger.info(f'Successfully authenticated as {username}')
+        user = await self.client.get_current_user()
+        self.logger.info(f'Successfully authenticated as {user["firstName"]} '
+                         f'{user["lastName"]} ({user["email"]})')
         self.logger.debug(f'Connected to API version {self.remote_version}')
 
     def prepare_local(self, template_dir):

dsw/tdk/validation.py

@@ -63,7 +63,7 @@ def _validate_version(field_name: str, value) -> List[ValidationError]:
 
 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 {field_name} must be positive integer')]
+        return [ValidationError(field_name, 'It must be positive integer')]
     return []
 
 
@@ -173,9 +173,7 @@ def _validate_steps(field_name: str, value: List[Step]) -> List[ValidationError]
 FormatValidator = GenericValidator({
     'uuid': [_validate_required, _validate_non_empty],
     'name': [_validate_required, _validate_non_empty],
-    'short_name': [_validate_required, _validate_non_empty],
     'icon': [_validate_required, _validate_non_empty],
-    'color': [_validate_required, _validate_non_empty],
     'steps': [_validate_required, _validate_steps],
 })
 
@@ -198,7 +196,6 @@ TemplateValidator = GenericValidator({
     'name': [_validate_required, _validate_non_empty],
     'description': [_validate_required, _validate_non_empty],
     'readme': [_validate_required, _validate_non_empty],
-    'recommended_package_id': [_validate_package_id],
     'license': [_validate_required, _validate_non_empty],
     'metamodel_version': [_validate_natural],
     'allowed_packages': [_validate_package_filters],

{dsw_tdk-3.22.1.dist-info → dsw_tdk-3.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-tdk
-Version: 3.22.1
+Version: 3.24.0
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -12,14 +12,12 @@ Classifier: Framework :: AsyncIO
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.7
+Requires-Python: <4,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp

dsw_tdk-3.24.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+dsw/tdk/__init__.py,sha256=zJeTybb0SqiNdGLkANjRa36hku4axi17mZL2dM3tHto,288
+dsw/tdk/__main__.py,sha256=IkqeOatxravhcQCdk4l0BkbaMILkgVopB9phYCIR1uo,38
+dsw/tdk/api_client.py,sha256=1Mk-OCtVNY_86JLUys72Fam0T7mGff7CMqsZDon8e0c,14205
+dsw/tdk/build_info.py,sha256=4IFfjHb9Q4Q7k-W9WU72RyOB1eTM1a4KroWDgiePDFM,381
+dsw/tdk/cli.py,sha256=EEvbvGrReh-R0_hKVCm9Nicc50qXCNERS_FhloW_p-w,22154
+dsw/tdk/consts.py,sha256=iU8yoZLoqI5nnccQGVxBzf74JppwnU1fxtqZNJ28Bo4,635
+dsw/tdk/core.py,sha256=xUbwWR7bl8K5leW8ML3Phu-XjXVejl-H8TF8RLxqVy4,25001
+dsw/tdk/model.py,sha256=B9_cCmg_Z2IHabMMychKFV4dh4SFPVEentuPcb5fzlY,17235
+dsw/tdk/utils.py,sha256=xt7INb2t-ChyIbR-VyQSYrPWupu2ufOlpatxN9yGrz0,4877
+dsw/tdk/validation.py,sha256=hr04MRVqwBIBeKoX6v53Ix1S-vjvIQYM5dwI0SnMRsc,7827
+dsw/tdk/templates/README.md.j2,sha256=FzUABeMM8To0oT48Kytoox64uAZ8F7FSAAXgpyKzqdU,247
+dsw/tdk/templates/starter.j2,sha256=XjZy3T9i8aWFlq4clXL6Q4JNh455crGelR9AoHisTbw,296
+dsw_tdk-3.24.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dsw_tdk-3.24.0.dist-info/METADATA,sha256=Mp3gyrBrZyehwr8Uj2yXFIEC249E6W0SzayyFblGeIY,6149
+dsw_tdk-3.24.0.dist-info/WHEEL,sha256=a-zpFRIJzOq5QfuhBzbhiA1eHTzNCJn8OdRvhdNX0Rk,110
+dsw_tdk-3.24.0.dist-info/entry_points.txt,sha256=lwD5ZzRCbTFSjP1-SkhYsaJe8sEXOWWgMAMUhw0v2Hk,41
+dsw_tdk-3.24.0.dist-info/top_level.txt,sha256=7SfbsHFoJ_vlAgG6C-xzETETwYO71dBrGnod8uMFnjw,4
+dsw_tdk-3.24.0.dist-info/RECORD,,

dsw_tdk-3.22.1.dist-info/RECORD

@@ -1,18 +0,0 @@
-dsw/tdk/__init__.py,sha256=zJeTybb0SqiNdGLkANjRa36hku4axi17mZL2dM3tHto,288
-dsw/tdk/__main__.py,sha256=IkqeOatxravhcQCdk4l0BkbaMILkgVopB9phYCIR1uo,38
-dsw/tdk/api_client.py,sha256=_iTJs4t4xaoQEm_4yRhUbU5xVXZXlkPd9rc6-Sl9HtM,14085
-dsw/tdk/build_info.py,sha256=bFisVzo1HaYqfJuTaGtWuzNAzmtiATo4bxTgS6O9YPU,381
-dsw/tdk/cli.py,sha256=9_A3w7N1wCWg07f8FrnD30yfpe7t_fcsbQldoCwhahk,20129
-dsw/tdk/consts.py,sha256=daHCLPRc35xZHgPPWItzXYpUbhuMNkQ1Xn9ydbEbP3Q,635
-dsw/tdk/core.py,sha256=BDRnfwI7yhAkQfzEIRF3VRPDkpX-Owmw2ATMsEyh6g8,24633
-dsw/tdk/model.py,sha256=B9_cCmg_Z2IHabMMychKFV4dh4SFPVEentuPcb5fzlY,17235
-dsw/tdk/utils.py,sha256=xt7INb2t-ChyIbR-VyQSYrPWupu2ufOlpatxN9yGrz0,4877
-dsw/tdk/validation.py,sha256=GuLClmYwpSr0sU4xz0TZo7jXPgDjAqRxLjgrLoHDdg0,8014
-dsw/tdk/templates/README.md.j2,sha256=FzUABeMM8To0oT48Kytoox64uAZ8F7FSAAXgpyKzqdU,247
-dsw/tdk/templates/starter.j2,sha256=XjZy3T9i8aWFlq4clXL6Q4JNh455crGelR9AoHisTbw,296
-dsw_tdk-3.22.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dsw_tdk-3.22.1.dist-info/METADATA,sha256=_QeXOApAsQ6tktxJiege2gPkMl4qR7AIUY3EFy4nw8Q,6249
-dsw_tdk-3.22.1.dist-info/WHEEL,sha256=a-zpFRIJzOq5QfuhBzbhiA1eHTzNCJn8OdRvhdNX0Rk,110
-dsw_tdk-3.22.1.dist-info/entry_points.txt,sha256=lwD5ZzRCbTFSjP1-SkhYsaJe8sEXOWWgMAMUhw0v2Hk,41
-dsw_tdk-3.22.1.dist-info/top_level.txt,sha256=7SfbsHFoJ_vlAgG6C-xzETETwYO71dBrGnod8uMFnjw,4
-dsw_tdk-3.22.1.dist-info/RECORD,,