dbt-platform-helper 14.1.0__py3-none-any.whl → 14.2.0__py3-none-any.whl

dbt_platform_helper/COMMANDS.md

@@ -29,11 +29,14 @@
         - [platform-helper secrets list](#platform-helper-secrets-list)
     - [platform-helper notify](#platform-helper-notify)
         - [platform-helper notify environment-progress](#platform-helper-notify-environment-progress)
+        - [platform-helper notify post-message](#platform-helper-notify-post-message)
         - [platform-helper notify add-comment](#platform-helper-notify-add-comment)
     - [platform-helper database](#platform-helper-database)
         - [platform-helper database dump](#platform-helper-database-dump)
         - [platform-helper database load](#platform-helper-database-load)
         - [platform-helper database copy](#platform-helper-database-copy)
+    - [platform-helper version](#platform-helper-version)
+        - [platform-helper version get-platform-helper-for-project](#platform-helper-version-get-platform-helper-for-project)
 
 # platform-helper
 
@@ -63,6 +66,7 @@ platform-helper <command> [--version]
 - [`notify` ↪](#platform-helper-notify)
 - [`pipeline` ↪](#platform-helper-pipeline)
 - [`secrets` ↪](#platform-helper-secrets)
+- [`version` ↪](#platform-helper-version)
 
 # platform-helper application
 
@@ -665,7 +669,7 @@ platform-helper secrets list <application> <environment>
 ## Usage
 
 ```
-platform-helper notify (environment-progress|add-comment) 
+platform-helper notify (environment-progress|post-message|add-comment) 
 ```
 
 ## Options
@@ -677,6 +681,7 @@ platform-helper notify (environment-progress|add-comment)
 
 - [`add-comment` ↪](#platform-helper-notify-add-comment)
 - [`environment-progress` ↪](#platform-helper-notify-environment-progress)
+- [`post-message` ↪](#platform-helper-notify-post-message)
 
 # platform-helper notify environment-progress
 
@@ -709,6 +714,41 @@ platform-helper notify environment-progress <slack_channel_id> <slack_token>
 
 - `--commit-sha <text>`
 
+- `--slack-ref <text>`
+  - Slack message reference of the message to update
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+# platform-helper notify post-message
+
+[↩ Parent](#platform-helper-notify)
+
+    Send Slack notifications. This creates (or updates if --slack-ref is provided) the top level message to the channel.
+
+## Usage
+
+```
+platform-helper notify post-message <slack_channel_id> <slack_token> 
+                                    <message> 
+                                    [--build-arn <build_arn>] [--repository <repository>] 
+                                    [--commit-sha <commit_sha>] 
+                                    [--slack-ref <slack_ref>] 
+```
+
+## Arguments
+
+- `slack-channel-id <text>`
+- `slack-token <text>`
+- `message <text>`
+
+## Options
+
+- `--build-arn <text>`
+
+- `--repository <text>`
+
+- `--commit-sha <text>`
+
 - `--slack-ref <text>`
   - Slack message reference of the message to update
 - `--help <boolean>` _Defaults to False._
@@ -866,3 +906,44 @@ platform-helper database copy --from <from_env> --to <to_env> --database <databa
 
 - `--help <boolean>` _Defaults to False._
   - Show this message and exit.
+
+# platform-helper version
+
+[↩ Parent](#platform-helper)
+
+    Contains subcommands for getting version information about the current
+    project.
+
+## Usage
+
+```
+platform-helper version get-platform-helper-for-project 
+```
+
+## Options
+
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.
+
+## Commands
+
+- [`get-platform-helper-for-project` ↪](#platform-helper-version-get-platform-helper-for-project)
+
+# platform-helper version get-platform-helper-for-project
+
+[↩ Parent](#platform-helper-version)
+
+    Print the version of platform-tools required by the current project
+
+## Usage
+
+```
+platform-helper version get-platform-helper-for-project [--pipeline <pipeline>] 
+```
+
+## Options
+
+- `--pipeline <text>`
+  - Take into account platform-tools version overrides in the specified pipeline
+- `--help <boolean>` _Defaults to False._
+  - Show this message and exit.

dbt_platform_helper/commands/notify.py

@@ -14,7 +14,8 @@ def notify():
 
 
 @notify.command(
-    help="Send environment progress notifications. This creates (or updates if --slack-ref is provided) the top level message to the channel."
+    help="Send environment progress notifications. This creates (or updates if --slack-ref is provided) the top level message to the channel.",
+    deprecated=True,
 )
 @click.argument("slack-channel-id")
 @click.argument("slack-token")
@@ -23,7 +24,41 @@ def notify():
 @click.option("--repository")
 @click.option("--commit-sha")
 @click.option("--slack-ref", help="Slack message reference of the message to update")
+@click.pass_context
 def environment_progress(
+    ctx,
+    slack_channel_id: str,
+    slack_token: str,
+    message: str,
+    build_arn: str,
+    repository: str,
+    commit_sha: str,
+    slack_ref: str,
+):
+
+    ctx.invoke(
+        post_message,
+        slack_channel_id=slack_channel_id,
+        slack_token=slack_token,
+        message=message,
+        build_arn=build_arn,
+        repository=repository,
+        commit_sha=commit_sha,
+        slack_ref=slack_ref,
+    )
+
+
+@notify.command(
+    help="Send Slack notifications. This creates (or updates if --slack-ref is provided) the top level message to the channel."
+)
+@click.argument("slack-channel-id")
+@click.argument("slack-token")
+@click.argument("message")
+@click.option("--build-arn")
+@click.option("--repository")
+@click.option("--commit-sha")
+@click.option("--slack-ref", help="Slack message reference of the message to update")
+def post_message(
     slack_channel_id: str,
     slack_token: str,
     message: str,
@@ -35,7 +70,7 @@ def environment_progress(
     try:
         io = ClickIOProvider()
         slack_notifier = SlackChannelNotifier(slack_token, slack_channel_id)
-        result = Notify(slack_notifier).environment_progress(
+        result = Notify(slack_notifier).post_message(
             original_message_ref=slack_ref,
             message=message,
             build_arn=build_arn,

dbt_platform_helper/commands/version.py

@@ -0,0 +1,31 @@
+import click
+
+from dbt_platform_helper.domain.versioning import PlatformHelperVersioning
+from dbt_platform_helper.platform_exception import PlatformException
+from dbt_platform_helper.providers.io import ClickIOProvider
+from dbt_platform_helper.utils.click import ClickDocOptGroup
+
+
+@click.group(chain=True, cls=ClickDocOptGroup)
+def version():
+    """Contains subcommands for getting version information about the current
+    project."""
+
+
+@version.command(help="Print the version of platform-tools required by the current project")
+@click.option(
+    "--pipeline",
+    required=False,
+    type=str,
+    help="Take into account platform-tools version overrides in the specified pipeline",
+)
+def get_platform_helper_for_project(pipeline):
+    """
+    Deprecated: Required in pipelines for projects running platform-helper < 14.0.0.
+
+    Version preferences removed, requires specifying platform-helper version in platform-config.yml
+    """
+    try:
+        PlatformHelperVersioning().get_required_version()
+    except PlatformException as err:
+        ClickIOProvider().abort_with_error(str(err))

dbt_platform_helper/domain/notify.py

@@ -6,7 +6,7 @@ class Notify:
     def __init__(self, notifier: SlackChannelNotifier):
         self.notifier = notifier
 
-    def environment_progress(
+    def post_message(
         self,
         message: str,
         build_arn: str = None,

{dbt_platform_helper-14.1.0.dist-info → dbt_platform_helper-14.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbt-platform-helper
-Version: 14.1.0
+Version: 14.2.0
 Summary: Set of tools to help transfer applications/services from GOV.UK PaaS to DBT PaaS augmenting AWS Copilot.
 License: MIT
 Author: Department for Business and Trade Platform Team

{dbt_platform_helper-14.1.0.dist-info → dbt_platform_helper-14.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dbt_platform_helper/COMMANDS.md,sha256=gxvvghHlPmcxjhTdXxfSVDI4sYXx95HZrCykoo5DI0I,21731
+dbt_platform_helper/COMMANDS.md,sha256=szFwoNuKlrTfGv10jA0zLG_HDgRnzPaI4rBBSgFXtu8,23883
 dbt_platform_helper/README.md,sha256=B0qN2_u_ASqqgkGDWY2iwNGZt_9tUgMb9XqtaTuzYjw,1530
 dbt_platform_helper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dbt_platform_helper/addon-plans.yml,sha256=O46a_ODsGG9KXmQY_1XbSGqrpSaHSLDe-SdROzHx8Go,4545
@@ -11,9 +11,10 @@ dbt_platform_helper/commands/copilot.py,sha256=L9UUuqD62q0aFrTTEUla3A1WJBz-vFBfV
 dbt_platform_helper/commands/database.py,sha256=2RJZEzaSqcNtDG1M2mZw-nB6agAd3GNAJsg2pjFF7vc,4407
 dbt_platform_helper/commands/environment.py,sha256=zexiry6_dbOmD8w2lBrgdcFQKAG7XyJg9pvNtwtgPRk,3616
 dbt_platform_helper/commands/generate.py,sha256=4M0ZiGN2w-bwgPMxeItFfT6vA7sOMjuceHEN7RAYkhc,735
-dbt_platform_helper/commands/notify.py,sha256=H7QHbnYQnCD357Kesq7h16fT19imFI1BLtLA8x3ujTM,2504
+dbt_platform_helper/commands/notify.py,sha256=DMXA0AHot6-7CMzmY0PXPMMBVnLgvQgXr6np6OnSQh4,3401
 dbt_platform_helper/commands/pipeline.py,sha256=PGpDDmyReVa4gdpXDwJEsHN51f5MgTIbm2AibTkuWrE,2580
 dbt_platform_helper/commands/secrets.py,sha256=haSbF401H4XLzS9LWGLC6h_EcZHLcIF-rW1XkzUOy58,3985
+dbt_platform_helper/commands/version.py,sha256=2GltWeeN7cqhVj9FhYWSbXSQSyNILHVNOeANGWtAllY,1097
 dbt_platform_helper/constants.py,sha256=Ao2uvVRcxRN5SXqvW6Jq2srd7LuyGz1jPy4fg2N6XSk,1153
 dbt_platform_helper/default-extensions.yml,sha256=SU1ZitskbuEBpvE7efc3s56eAUF11j70brhj_XrNMMo,493
 dbt_platform_helper/domain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -24,7 +25,7 @@ dbt_platform_helper/domain/copilot.py,sha256=9L4h-WFwgRU8AMjf14PlDqwLqOpIRinkuPv
 dbt_platform_helper/domain/copilot_environment.py,sha256=fL3XJCOfO0BJRCrCoBPFCcshrQoX1FeSYNTziOEaH4A,9093
 dbt_platform_helper/domain/database_copy.py,sha256=AedcBTfKDod0OlMqVP6zb9c_9VIc3vqro0oUUhh7nwc,9497
 dbt_platform_helper/domain/maintenance_page.py,sha256=0_dgM5uZvjVNBKcqScspjutinMh-7Hdm7jBEgUPujrk,14529
-dbt_platform_helper/domain/notify.py,sha256=wTWBhFQkZG31V2OlZJVqzUPRTZqJxHtij9PAURXoxnU,1902
+dbt_platform_helper/domain/notify.py,sha256=_BWj5znDWtrSdJ5xzDBgnao4ukliBA5wiUZGobIDyiI,1894
 dbt_platform_helper/domain/pipelines.py,sha256=BUoXlV4pIKSw3Ry6oVMzd0mBU6tfl_tvqp-1zxHrQdk,6552
 dbt_platform_helper/domain/terraform_environment.py,sha256=kPfA44KCNnF_7ihQPuxaShLjEnVShrbruLwr5xoCeRc,1825
 dbt_platform_helper/domain/versioning.py,sha256=L1PKuAnGtd1E6WT2cssC9hCVUibllntk-Tut8vdgJfk,5502
@@ -95,9 +96,9 @@ dbt_platform_helper/utils/git.py,sha256=9jyLhv37KKE6r-_hb3zvjhTbluA81kdrOdNeG6MB
 dbt_platform_helper/utils/messages.py,sha256=nWA7BWLb7ND0WH5TejDN4OQUJSKYBxU4tyCzteCrfT0,142
 dbt_platform_helper/utils/template.py,sha256=g-Db-0I6a6diOHkgK1nYA0IxJSO4TRrjqOvlyeOR32o,950
 dbt_platform_helper/utils/validation.py,sha256=coN7WsKW_nPGW9EU23AInBkAuvUl1NfQvc2bjVtgs14,1188
-platform_helper.py,sha256=M0fDSY5f5NnlC6NESb4LMMuu5c1vsSPZQAXJoJj4suM,1802
-dbt_platform_helper-14.1.0.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
-dbt_platform_helper-14.1.0.dist-info/METADATA,sha256=3-Uh_GtuVaWCovKYSLKJ_ZlaEKmja7Fdfg6KiSGiSvE,3293
-dbt_platform_helper-14.1.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-dbt_platform_helper-14.1.0.dist-info/entry_points.txt,sha256=QhbY8F434A-onsg0-FsdMd2U6HKh6Q7yCFFZrGUh5-M,67
-dbt_platform_helper-14.1.0.dist-info/RECORD,,
+platform_helper.py,sha256=_YNNGtMkH5BcpC_mQQYJrmlf2mt7lkxTYeH7ZgflPoA,1925
+dbt_platform_helper-14.2.0.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
+dbt_platform_helper-14.2.0.dist-info/METADATA,sha256=jWQxX9xd3BXMMN_nHHFnoRPGfQvyhrJcdGbBlK_Mpug,3293
+dbt_platform_helper-14.2.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+dbt_platform_helper-14.2.0.dist-info/entry_points.txt,sha256=QhbY8F434A-onsg0-FsdMd2U6HKh6Q7yCFFZrGUh5-M,67
+dbt_platform_helper-14.2.0.dist-info/RECORD,,

platform_helper.py

@@ -15,6 +15,7 @@ from dbt_platform_helper.commands.generate import generate as generate_commands
 from dbt_platform_helper.commands.notify import notify as notify_commands
 from dbt_platform_helper.commands.pipeline import pipeline as pipeline_commands
 from dbt_platform_helper.commands.secrets import secrets as secrets_commands
+from dbt_platform_helper.commands.version import version as version_commands
 from dbt_platform_helper.utils.click import ClickDocOptGroup
 
 
@@ -38,6 +39,7 @@ platform_helper.add_command(pipeline_commands)
 platform_helper.add_command(secrets_commands)
 platform_helper.add_command(notify_commands)
 platform_helper.add_command(database_commands)
+platform_helper.add_command(version_commands)
 
 if __name__ == "__main__":
     platform_helper(auto_envvar_prefix="DBT_PLATFORM")