dsw-tdk 3.26.2__py2.py3-none-any.whl → 3.27.1__py2.py3-none-any.whl

dsw/tdk/api_client.py

@@ -81,7 +81,7 @@ class DSWAPIClient:
                         f'{r.reason} (expecting {expected_status})'
             )
 
-    def __init__(self, api_url: str, session=None):
+    def __init__(self, api_url: str, api_key: str, session=None):
         """
         Exception representing communication error with DSW.
 
@@ -90,7 +90,7 @@ class DSWAPIClient:
             session (aiohttp.ClientSession): Optional custom session for HTTP communication.
         """
         self.api_url = api_url
-        self.token = None
+        self.token = api_key
         self.session = session or aiohttp.ClientSession(connector=aiohttp.TCPConnector(ssl=False))
 
     @property

dsw/tdk/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v3.26.2~9194676',
-    built_at='2023-09-20 13:02:07Z',
-    sha='919467612be55f5f7a352f1282cd31f94bb9ef84',
+    version='v3.27.1~4be9747',
+    built_at='2023-09-20 13:02:55Z',
+    sha='4be974749848a367bb7558c64b2f732e85ed8d75',
     branch='HEAD',
-    tag='v3.26.2',
+    tag='v3.27.1',
 )

dsw/tdk/cli.py

@@ -1,5 +1,4 @@
 import asyncio
-import sys
 
 import click  # type: ignore
 import datetime
@@ -96,6 +95,10 @@ def rectify_url(ctx, param, value) -> str:
     return value.rstrip('/')
 
 
+def rectify_key(ctx, param, value) -> str:
+    return value.strip()
+
+
 class ClickLogger(logging.Logger):
 
     NAME = 'DSW-TDK-CLI'
@@ -169,6 +172,7 @@ class CLIContext:
 
     def __init__(self):
         self.logger = ClickLogger.default()
+        self.dot_env_file = None
 
     def debug_mode(self):
         self.logger.show_timestamp = True
@@ -178,37 +182,6 @@ 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]
@@ -273,13 +246,14 @@ def main(ctx, quiet, debug, dot_env):
     if pathlib.Path(dot_env).exists():
         dotenv.load_dotenv(dotenv_path=dot_env)
     ctx.ensure_object(CLIContext)
+    ctx.obj.dot_env_file = dot_env
     if quiet:
         ctx.obj.quiet_mode()
     if debug:
         ctx.obj.debug_mode()
 
 
-@main.command(help='Create a new DSW template project.', name='new')
+@main.command(help='Create a new template project.', name='new')
 @click.argument('TEMPLATE-DIR', type=NEW_DIR_TYPE, default=None, required=False)
 @click.option('-f', '--force', is_flag=True, help='Overwrite any matching files.')
 @click.pass_context
@@ -303,30 +277,25 @@ def new_template(ctx, template_dir, force):
         exit(1)
 
 
-@main.command(help='Download template from DSW.', name='get')
+@main.command(help='Download template from Wizard.', name='get')
 @click.argument('TEMPLATE-ID')
 @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', 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('-u', '--api-url', metavar='API-URL', envvar='DSW_API_URL',
+              prompt='API URL', help='URL of Wizard server API.', callback=rectify_url)
+@click.option('-k', '--api-key', metavar='API-KEY', envvar='DSW_API_KEY',
+              prompt='API Key', help='API key for Wizard instance.', callback=rectify_key,
+              hide_input=True)
 @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, api_key, force):
+def get_template(ctx, api_url, template_id, template_dir, 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, **creds.init_args())
+            await tdk.init_client(api_url=api_url, api_key=api_key)
             try:
                 await tdk.load_remote(template_id=template_id)
                 template_type = 'draft'
@@ -367,23 +336,18 @@ def get_template(ctx, api_server, template_id, template_dir, username, password,
     loop.run_until_complete(main_routine())
 
 
-@main.command(help='Upload template to DSW.', name='put')
+@main.command(help='Upload template to Wizard.', name='put')
 @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', 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('-u', '--api-url', metavar='API-URL', envvar='DSW_API_URL',
+              prompt='API URL', help='URL of Wizard server API.', callback=rectify_url)
+@click.option('-k', '--api-key', metavar='API-KEY', envvar='DSW_API_KEY',
+              prompt='API Key', help='API key for Wizard instance.', callback=rectify_key,
+              hide_input=True)
 @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, api_key, force, watch):
+def put_template(ctx, api_url, template_dir, 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)
@@ -399,10 +363,10 @@ def put_template(ctx, api_server, template_dir, username, password, api_key, for
     async def main_routine():
         load_local(tdk, template_dir)
         try:
-            await tdk.init_client(api_url=api_server, **creds.init_args())
+            await tdk.init_client(api_url=api_url, api_key=api_key)
             await tdk.store_remote(force=force)
             ClickPrinter.success(f'Template {tdk.safe_project.safe_template.id} '
-                                 f'uploaded to {api_server}')
+                                 f'uploaded to {api_url}')
 
             if watch:
                 ClickPrinter.watch('Entering watch mode... (press Ctrl+C to abort)')
@@ -427,7 +391,7 @@ def put_template(ctx, api_server, template_dir, username, password, api_key, for
     loop.run_until_complete(main_routine())
 
 
-@main.command(help='Create ZIP package for DSW template.', name='package')
+@main.command(help='Create ZIP package for a template.', name='package')
 @click.argument('TEMPLATE-DIR', type=DIR_TYPE, default=CURRENT_DIR, required=False)
 @click.option('-o', '--output', default='template.zip', type=click.Path(writable=True),
               show_default=True, help='Target package file.')
@@ -446,7 +410,7 @@ def create_package(ctx, template_dir, output, force: bool):
     ClickPrinter.success(f'Package {filename} created')
 
 
-@main.command(help='Extract DSW template from ZIP package', name='unpackage')
+@main.command(help='Extract a template from ZIP package', name='unpackage')
 @click.argument('TEMPLATE-PACKAGE', type=FILE_READ_TYPE, required=False)
 @click.option('-o', '--output', type=NEW_DIR_TYPE, default=None, required=False,
               help='Target package file.')
@@ -468,29 +432,23 @@ def extract_package(ctx, template_package, output, force: bool):
     ClickPrinter.success(f'Package {template_package} extracted')
 
 
-@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', 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.')
+@main.command(help='List templates from Wizard via API.', name='list')
+@click.option('-u', '--api-url', metavar='API-URL', envvar='DSW_API_URL',
+              prompt='API URL', help='URL of Wizard server API.', callback=rectify_url)
+@click.option('-k', '--api-key', metavar='API-KEY', envvar='DSW_API_KEY',
+              prompt='API Key', help='API key for Wizard instance.', callback=rectify_key,
+              hide_input=True)
 @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, api_key, output_format: str,
+def list_templates(ctx, api_url, 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_url=api_server, **creds.init_args())
+            await tdk.init_client(api_url=api_url, api_key=api_key)
             if released_only:
                 templates = await tdk.list_remote_templates()
                 for template in templates:
@@ -520,7 +478,7 @@ def list_templates(ctx, api_server, username, password, api_key, output_format:
     loop.run_until_complete(main_routine())
 
 
-@main.command(help='Verify DSW template project.', name='verify')
+@main.command(help='Verify a template project.', name='verify')
 @click.argument('TEMPLATE-DIR', type=DIR_TYPE, default=CURRENT_DIR, required=False)
 @click.pass_context
 def verify_template(ctx, template_dir):
@@ -535,3 +493,28 @@ def verify_template(ctx, template_dir):
         click.echo('Found violations:')
         for err in errors:
             click.echo(f' - {err.field_name}: {err.message}')
+
+
+@main.command(help='Create a .env file.', name='dot-env')
+@click.argument('TEMPLATE-DIR', type=DIR_TYPE, default=CURRENT_DIR, required=False)
+@click.option('-u', '--api-url', metavar='API-URL', envvar='DSW_API_URL',
+              prompt='API URL', help='URL of Wizard server API.', callback=rectify_url)
+@click.option('-k', '--api-key', metavar='API-KEY', envvar='DSW_API_KEY',
+              prompt='API Key', help='API key for Wizard instance.', callback=rectify_key,
+              hide_input=True)
+@click.option('-f', '--force', is_flag=True, help='Overwrite file if already exists.')
+@click.pass_context
+def create_dot_env(ctx, template_dir, api_url, api_key, force):
+    filename = ctx.obj.dot_env_file or '.env'
+    tdk = TDKCore(logger=ctx.obj.logger)
+    try:
+        tdk.create_dot_env(
+            output=pathlib.Path(template_dir) / filename,
+            force=force,
+            api_url=api_url,
+            api_key=api_key,
+        )
+    except Exception as e:
+        ClickPrinter.failure('Failed to create dot-env file')
+        ClickPrinter.error(f'> {e}')
+        exit(1)

dsw/tdk/consts.py

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

dsw/tdk/core.py

@@ -15,7 +15,7 @@ from typing import List, Optional, Tuple
 from .api_client import DSWAPIClient, DSWCommunicationError
 from .consts import DEFAULT_ENCODING, REGEX_SEMVER
 from .model import TemplateProject, Template, TemplateFile, TemplateFileType
-from .utils import UUIDGen
+from .utils import UUIDGen, create_dot_env
 from .validation import ValidationError, TemplateValidator
 
 
@@ -99,14 +99,9 @@ class TDKCore:
             raise RuntimeError('No DSW API client specified')
         return self.client
 
-    async def init_client(self, api_url: str, username: Optional[str] = None,
-                          password: Optional[str] = None, api_key: Optional[str] = None):
+    async def init_client(self, api_url: str, api_key: str):
         self.logger.info(f'Connecting to {api_url}')
-        self.client = DSWAPIClient(api_url=api_url)
-        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.client = DSWAPIClient(api_url=api_url, api_key=api_key)
         self.remote_version = await self.client.get_api_version()
         user = await self.client.get_current_user()
         self.logger.info(f'Successfully authenticated as {user["firstName"]} '
@@ -362,6 +357,17 @@ class TDKCore:
                 target_file.write_text(data=content, encoding=DEFAULT_ENCODING)
         self.logger.debug('Extracting package done')
 
+    def create_dot_env(self, output: pathlib.Path, force: bool, api_url: str, api_key: str):
+        if output.exists():
+            if force:
+                self.logger.warning(f'Overwriting {output.as_posix()} (forced)')
+            else:
+                raise RuntimeError(f'File {output} already exists (not forced)')
+        output.write_text(
+            data=create_dot_env(api_url=api_url, api_key=api_key),
+            encoding=DEFAULT_ENCODING,
+        )
+
     async def watch_project(self, callback):
         async for changes in watchgod.awatch(self.safe_project.template_dir):
             await callback((

dsw/tdk/templates/LICENSE.j2

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

dsw/tdk/templates/env.j2

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

dsw/tdk/utils.py

@@ -2,7 +2,7 @@ import jinja2  # type: ignore
 import pathlib
 import uuid
 
-from typing import List, Set
+from typing import List, Set, Optional
 
 from .consts import DEFAULT_ENCODING, DEFAULT_README
 from .model import Template, TemplateFile, Format, Step, PackageFilter
@@ -163,13 +163,33 @@ class TemplateBuilder:
         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)
+                content=content.encode(encoding=DEFAULT_ENCODING),
             )
             self.template.tdk_config.files.append(str(format_spec.filename))
         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='LICENSE',
+            content_type='text/plain',
+            content=license_file.encode(encoding=DEFAULT_ENCODING),
+        )
+
+        self.template.files['.env'] = TemplateFile(
+            filename='.env',
+            content_type='text/plain',
+            content=create_dot_env().encode(encoding=DEFAULT_ENCODING),
+        )
+
         return self.template
+
+
+def create_dot_env(api_url: Optional[str] = None, api_key: Optional[str] = None) -> str:
+    return j2_env.get_template('env.j2').render(api_url=api_url, api_key=api_key)

{dsw_tdk-3.26.2.dist-info → dsw_tdk-3.27.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-tdk
-Version: 3.26.2
+Version: 3.27.1
 Summary: Data Stewardship Wizard Template Development Toolkit
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0

dsw_tdk-3.27.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+dsw/tdk/__init__.py,sha256=zJeTybb0SqiNdGLkANjRa36hku4axi17mZL2dM3tHto,288
+dsw/tdk/__main__.py,sha256=IkqeOatxravhcQCdk4l0BkbaMILkgVopB9phYCIR1uo,38
+dsw/tdk/api_client.py,sha256=N3-PoO__kPtqFmR2QY-OG-9OkjYZwuXg8JxcBgpI8vQ,14222
+dsw/tdk/build_info.py,sha256=0D8BZnbHMf_AUQ3g7SeT-D0b4ttuFOM8u_YvLJwblMc,381
+dsw/tdk/cli.py,sha256=hAMvP2RRaPLu3w7aCLAIF12_7KsxFc2R_uT8cPUY3Jw,21199
+dsw/tdk/consts.py,sha256=5bxycH8OL2Ylb95MzOYZxHRlJaLgj0JwKAZuVrvve2E,635
+dsw/tdk/core.py,sha256=yReFEbC1_9AP0Pqwl-XPdP9zRiDKSKiPDdD1LQ6qSik,25177
+dsw/tdk/model.py,sha256=B9_cCmg_Z2IHabMMychKFV4dh4SFPVEentuPcb5fzlY,17235
+dsw/tdk/utils.py,sha256=SFmb9Q2YO4ppY1B4ZMbRYMlrUa1ObXfbsSc4rPpBJI0,5616
+dsw/tdk/validation.py,sha256=hr04MRVqwBIBeKoX6v53Ix1S-vjvIQYM5dwI0SnMRsc,7827
+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=7IJ6HAIY1bXKLake4c72DSEUcQtAquO5wlSgH8vg_8s,97
+dsw/tdk/templates/starter.j2,sha256=XjZy3T9i8aWFlq4clXL6Q4JNh455crGelR9AoHisTbw,296
+dsw_tdk-3.27.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dsw_tdk-3.27.1.dist-info/METADATA,sha256=DrEC30a0XsJVQIHBGjgjde3_PHbgey1rfXLSy4R6CcI,6149
+dsw_tdk-3.27.1.dist-info/WHEEL,sha256=iYlv5fX357PQyRT2o6tw1bN-YcKFFHKqB_LwHO5wP-g,110
+dsw_tdk-3.27.1.dist-info/entry_points.txt,sha256=lwD5ZzRCbTFSjP1-SkhYsaJe8sEXOWWgMAMUhw0v2Hk,41
+dsw_tdk-3.27.1.dist-info/top_level.txt,sha256=7SfbsHFoJ_vlAgG6C-xzETETwYO71dBrGnod8uMFnjw,4
+dsw_tdk-3.27.1.dist-info/RECORD,,

dsw_tdk-3.26.2.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=1Mk-OCtVNY_86JLUys72Fam0T7mGff7CMqsZDon8e0c,14205
-dsw/tdk/build_info.py,sha256=R-CLCVxYhygXNSkHwnIkhee8jbMkJJ-5nVUbGYmA_80,381
-dsw/tdk/cli.py,sha256=EEvbvGrReh-R0_hKVCm9Nicc50qXCNERS_FhloW_p-w,22154
-dsw/tdk/consts.py,sha256=T0YkY5jyX24p66gf0cCpg6YWq0iClIMl1PzotKM2mz4,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.26.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dsw_tdk-3.26.2.dist-info/METADATA,sha256=rSiFZE9IZu0kj2FQD7GGBXB2RO_iLhLpLEs9NqYI2vs,6149
-dsw_tdk-3.26.2.dist-info/WHEEL,sha256=iYlv5fX357PQyRT2o6tw1bN-YcKFFHKqB_LwHO5wP-g,110
-dsw_tdk-3.26.2.dist-info/entry_points.txt,sha256=lwD5ZzRCbTFSjP1-SkhYsaJe8sEXOWWgMAMUhw0v2Hk,41
-dsw_tdk-3.26.2.dist-info/top_level.txt,sha256=7SfbsHFoJ_vlAgG6C-xzETETwYO71dBrGnod8uMFnjw,4
-dsw_tdk-3.26.2.dist-info/RECORD,,