aws-annoying 0.8.2__py3-none-any.whl → 0.8.3__py3-none-any.whl

aws_annoying/cli/app.py

@@ -21,7 +21,7 @@ app = typer.Typer(
 )
 
 
-def show_version(value: Optional[bool]) -> None:
+def show_version(value: Optional[bool]) -> None:  # noqa: FBT001
     """Show the version of the application."""
     if not value:
         return

aws_annoying/cli/ecs/task_definition_lifecycle.py

@@ -38,7 +38,21 @@ def task_definition_lifecycle(
         help="Delete the task definition after deregistering it.",
     ),
 ) -> None:
-    """Execute ECS task definition lifecycle."""
+    r"""Expire and delete ECS task definitions.
+
+    Expire and delete ECS task definitions for a given family, keeping revisions adhering to
+    the given constraint. You can use this command to clean up old task definitions that are no
+    longer needed.
+
+    Example usage:
+
+    ```shell
+    aws-annoying ecs task-definition-lifecycle \
+        --family <task-definition-family> \
+        --keep-latest 5 \
+        --delete
+    ```
+    """
     dry_run = ctx.meta["dry_run"]
     ecs = boto3.client("ecs")
 

aws_annoying/cli/ecs/wait_for_deployment.py

@@ -69,7 +69,42 @@ def wait_for_deployment(  # noqa: PLR0913
         help="Whether to wait for the service to be stable after the deployment.",
     ),
 ) -> None:
-    """Wait for ECS deployment to complete."""
+    r"""Wait for ECS deployment for a specific service to start, complete and stabilize.
+
+    It's designed to be used after triggering a deployment (e.g., updating service, deploying new task definition),
+    in conjunction with CI/CD pipelines or deployment scripts.
+
+    Below is an example of using this command in GitHub Actions workflow:
+
+    ```yaml
+      ...
+
+      - name: Deploy to ECS service
+        id: deploy-ecs
+        uses: aws-actions/amazon-ecs-deploy-task-definition@v2
+        with:
+          task-definition: ${{ steps.render-task-definition.outputs.task-definition }}
+          cluster: ${{ vars.AWS_ECS_CLUSTER }}
+          service: ${{ vars.AWS_ECS_SERVICE }}
+          wait-for-service-stability: false
+
+      - name: Wait for deployment complete
+        run: |
+          pipx run aws-annoying \
+            --verbose \
+            ecs wait-for-deployment \
+              --cluster '${{ vars.AWS_ECS_CLUSTER }}' \
+              --service '${{ vars.AWS_ECS_SERVICE }}' \
+              --wait-for-start \
+              --wait-for-stability \
+              --timeout-seconds 600 \
+              --expected-task-definition '${{ steps.deploy-ecs.outputs.task-definition-arn }}'
+
+      ...
+    ```
+
+    `--wait-for-start` is necessary because there could be no deployment right after the deploy action.
+    """
     start = datetime.now(tz=timezone.utc)
     try:
         with Timeout(timeout_seconds):

aws_annoying/cli/mfa/configure.py

@@ -54,7 +54,27 @@ def configure(  # noqa: PLR0913
         help="Persist the MFA configuration.",
     ),
 ) -> None:
-    """Configure AWS profile for MFA."""
+    r"""Configure AWS profile for MFA.
+
+    This command retrieves temporary MFA credentials using the provided source profile (`--mfa-source-profile`)
+    and MFA token code then updates the specified AWS profile with these credentials.
+
+    You can configure it interactively, by omitting the options, or provide them directly via command-line options.
+
+    ```shell
+    aws-annoying mfa configure
+    ```
+
+    If you want to use MFA as primary authentication method for an AWS profile, you can configure
+    it to save the credentials to the default profile.
+
+    ```shell
+    aws configure --profile mfa
+    aws-annoying mfa configure \
+        --mfa-profile default \
+        --mfa-source-profile mfa
+    ```
+    """
     dry_run = ctx.meta["dry_run"]
 
     # Expand user home directory

aws_annoying/cli/session_manager/port_forward.py

@@ -59,7 +59,14 @@ def port_forward(  # noqa: PLR0913
         help="The path to the log file to store the output of the session manager plugin.",
     ),
 ) -> None:
-    """Start a port forwarding session using AWS Session Manager."""
+    """Start a port forwarding session using AWS Session Manager.
+
+    This command allows starting a port forwarding session through an EC2 instance identified by its name or ID.
+    If there are more than one instance with the same name, the first one found will be used.
+
+    Also, it manages a PID file to keep track of the session manager plugin process running in background,
+    allowing to terminate any existing process before starting a new one.
+    """
     dry_run = ctx.meta["dry_run"]
     session_manager = SessionManager()
 

aws_annoying/cli/session_manager/start.py

@@ -30,7 +30,11 @@ def start(
         help="The reason for starting the session.",
     ),
 ) -> None:
-    """Start new session."""
+    """Start new session to your instance.
+
+    You can use your EC2 instance identified by its name or ID. If there are
+    more than one instance with the same name, the first one found will be used.
+    """
     dry_run = ctx.meta["dry_run"]
     session_manager = SessionManager()
 

aws_annoying/session_manager/session_manager.py

@@ -265,7 +265,7 @@ class SessionManager:
         Returns:
             The command to start the session.
         """
-        is_installed, binary_path, version = self.verify_installation()
+        is_installed, binary_path, _version = self.verify_installation()
         if not is_installed:
             msg = "Session Manager plugin is not installed."
             raise PluginNotInstalledError(msg)

aws_annoying/variable_loader.py

@@ -1,4 +1,3 @@
-# flake8: noqa: B008
 from __future__ import annotations
 
 import json

{aws_annoying-0.8.2.dist-info → aws_annoying-0.8.3.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.8.2
+Version: 0.8.3
 Summary: Utils to handle some annoying AWS tasks.
-Project-URL: Homepage, https://github.com/lasuillard/aws-annoying
-Project-URL: Repository, https://github.com/lasuillard/aws-annoying.git
-Project-URL: Issues, https://github.com/lasuillard/aws-annoying/issues
+Project-URL: Homepage, https://github.com/lasuillard-s/aws-annoying
+Project-URL: Repository, https://github.com/lasuillard-s/aws-annoying.git
+Project-URL: Issues, https://github.com/lasuillard-s/aws-annoying/issues
 Author-email: Yuchan Lee <lasuillard@gmail.com>
 License-Expression: MIT
 License-File: LICENSE
@@ -33,6 +33,7 @@ Major directories of the project:
 - **aws_annoying** Python package containing CLI and utility functions.
 - **console** Utilities to help working with AWS Console.
 - **examples** Examples of how to use the package.
+- **devcontainer-features** Devcontainer features to help set up development environment.
 
 ## 🚀 Installation
 
@@ -51,39 +52,7 @@ As the package also provides some utility functions, you can install `aws-annoyi
 
 ## 💡 Usage
 
-Below are brief explanation of available commands. For more detailed information about commands, please refer to the CLI help.
-
-### `ecs task-definition-lifecycle`
-
-Expire and delete ECS task definitions based on criteria.
-
-### `ecs wait-for-deployment`
-
-Wait for ECS deployment to start, complete or fail, and stabilize.
-
-### `load-variables`
-
-Wrapper command to run command with variables from various AWS resources (SSM Parameter Store, Secrets Manager, etc.) injected as environment variables.
-
-### `mfa configure`
-
-Configure AWS profile or refresh session for MFA.
-
-### `session-manager install`
-
-Install AWS Session Manager plugin.
-
-### `session-manager port-forward`
-
-Start a port forwarding session using AWS Session Manager.
-
-### `session-manager start`
-
-Start new session via Session Manager.
-
-### `session-manager stop`
-
-Stop running port forwarding session for PID file.
+Refer to the CLI help or documentation for detailed information on how to use each command.
 
 ## 💖 Contributing
 

{aws_annoying-0.8.2.dist-info → aws_annoying-0.8.3.dist-info}/RECORD

@@ -1,24 +1,24 @@
 aws_annoying/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 aws_annoying/mfa_config.py,sha256=z0GpRhLHEWaaXbECV4Ei4oNM1WCFoEZAxCIPbpY4Ymc,2200
-aws_annoying/variable_loader.py,sha256=N9qPPHG6mzSIIHrWJnJ_FV5kKZxssOaTHoAQEwiDE3s,4569
+aws_annoying/variable_loader.py,sha256=8QhQVc8SZOIdI7_uxp7NSyN2Pu8NT3TQl0HJl6pfTPk,4548
 aws_annoying/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aws_annoying/cli/app.py,sha256=W0FPz0N7okjENwaGpdoWRhcei5Xs-uxSMRaYldaza3M,3295
+aws_annoying/cli/app.py,sha256=uriIEx7tei1UVOcasCKqRM1jFdggvV1N4Ys_wPCKMVk,3311
 aws_annoying/cli/load_variables.py,sha256=n5CIci_uAoGaOZ4EKIKEEfcyMq81Hjy9AFOXq1-Hbh0,4896
 aws_annoying/cli/logging_handler.py,sha256=z2fBHChHiyzQeKtKjykX-JvuWm57gARB3VDmpQSdu6U,1409
 aws_annoying/cli/main.py,sha256=bU4Gxic5_3qrrd8l9eN709-D4o_OHgrdH91FS9Xs8zI,477
 aws_annoying/cli/ecs/__init__.py,sha256=IxfaMXcGU6WTHE_RXj-aitXtSg25j5m3HGTG9O02GjI,125
 aws_annoying/cli/ecs/_app.py,sha256=izD0VL55i7oG-2CtWCV21bSoAeE-DZbxyJ5pi6VXhjU,200
-aws_annoying/cli/ecs/task_definition_lifecycle.py,sha256=COGYy5o9N6J7tv6aA7qhT-4WsAoxbyPC1UMPtKKrPpg,2704
-aws_annoying/cli/ecs/wait_for_deployment.py,sha256=yBl-KMOya8ZSgpZLcEB0UqtsZfK5ezKPJWNaOdMRRcY,5234
+aws_annoying/cli/ecs/task_definition_lifecycle.py,sha256=dZc20CmzVcKjRJNev0AgzN3dPLUts1UjFNF7lW3Ax40,3098
+aws_annoying/cli/ecs/wait_for_deployment.py,sha256=o62qsjeFM5ZWaZyT8vav-a5r8-sS0NQlJfJnP9q7kpY,6518
 aws_annoying/cli/mfa/__init__.py,sha256=rbEGhw5lOQZV_XAc3nSbo56JVhsSPpeOgEtiAy9qzEA,50
 aws_annoying/cli/mfa/_app.py,sha256=Ub7gxb6kGF3Ve1ucQSOjHmc4jAu8mxgegcXsIbOzLLQ,189
-aws_annoying/cli/mfa/configure.py,sha256=Lfmc4VKkUGngbrbxLRrgcEv-vyPM_-1ne_G4U-Vh7Mg,4092
+aws_annoying/cli/mfa/configure.py,sha256=p91dkhlJzcYkjAKJnhZ7MlB9LatfLfJOe_d2qJ3fJbU,4773
 aws_annoying/cli/session_manager/__init__.py,sha256=FkT6jT6OXduOURN61d-U6hgd-XluQbvuVtKXXiXgSEk,105
 aws_annoying/cli/session_manager/_app.py,sha256=OVOHW0iyKzunvaqLhjoseHw1-WxJ1gGb7QmiyAEezyY,221
 aws_annoying/cli/session_manager/_common.py,sha256=Uj-MF7z8Qntd24Z03xxE-jSKcgrsd8xl41E6db4qCtY,711
 aws_annoying/cli/session_manager/install.py,sha256=QA88qIu7aYTlBN0tqU-lEN5nMGpshXF3jddBBCZixV8,1550
-aws_annoying/cli/session_manager/port_forward.py,sha256=7tSaGlcoSpJ9G2NYHvcC-PpmVqz-I4B4T8e4Xe45BE8,4495
-aws_annoying/cli/session_manager/start.py,sha256=p4vGUIT4IivJp_Sr7yYljRuYTDHBWULt2Av6AzAjL1I,1536
+aws_annoying/cli/session_manager/port_forward.py,sha256=PYRSeYg2RLH3rB3mO5RwYNZmnL95E-Z2RJXuvdOddlY,4890
+aws_annoying/cli/session_manager/start.py,sha256=27sTKMrdgG8UeQF1hz7l_1uWh2oOz06XYX-XhY_ab84,1717
 aws_annoying/cli/session_manager/stop.py,sha256=SrjGJdodTmcGK1OPyFX61vWzJTqgfsuBRFvScIdYJCU,1641
 aws_annoying/ecs/__init__.py,sha256=G9vVNkbDg-fY3G0Qc7yOGZOnsVp4VtiwzzEgjr6S5Kw,666
 aws_annoying/ecs/check.py,sha256=mxkW8MWCJYng60VKwq3Ws9PEvI1u0aVPdbs4p6SY2j4,1233
@@ -27,7 +27,7 @@ aws_annoying/ecs/errors.py,sha256=n9j_h1MDUV6IVabKgwbCVAiPZQNJDJ5rVRHA82Je5QQ,42
 aws_annoying/ecs/wait_for.py,sha256=Oj1u1uPp074-Pf-cvVNHxs-S6RLk8lh5EGsVFqi1iH0,6123
 aws_annoying/session_manager/__init__.py,sha256=IENviL3ux2LF7o9xFGYEiqaGw03hxnyNX2btbB1xyEU,318
 aws_annoying/session_manager/errors.py,sha256=YioKlRtZ-GUP0F_ts_ebw7-HYkxe8mTes6HK821Kuiw,353
-aws_annoying/session_manager/session_manager.py,sha256=pUsyJ_w9UzdIfHA2Z8kU6UcZxOqypFXH1rl6pDytdqo,12046
+aws_annoying/session_manager/session_manager.py,sha256=FmJEGdbsjYzt5CbE5CiNF5UyliGnzVzLq0ipfXusNyY,12047
 aws_annoying/session_manager/shortcuts.py,sha256=Yn4wCl43lfttrZ7GbzfGua2jZHe5Fe6ClEy4ikg-Q_s,2143
 aws_annoying/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 aws_annoying/utils/debugger.py,sha256=UFllDCGI2gPtwo1XS5vqw0qyR6bYr7XknmBwSxalKIc,754
@@ -35,8 +35,8 @@ aws_annoying/utils/downloader.py,sha256=bAh8Hu55L3F8Fyd1s4NBsyB_L0U-lk7SfKsS00Rp
 aws_annoying/utils/ec2.py,sha256=VsOrnFQDSNplWQ_s-uT11IfiD2mi-74uLbSVoaeXynI,1055
 aws_annoying/utils/platform.py,sha256=TBIzCzYiFj36HmndZedegvFlxPSNtBQyAxzuwelvxNg,985
 aws_annoying/utils/timeout.py,sha256=9eCSqhkEp7f7wBoLzkyqfyUKAgY9irwL6LIWBvIvmFI,2394
-aws_annoying-0.8.2.dist-info/METADATA,sha256=x4OS2Uc2ZaDB73aBVmzfSUdqvyp790bhte-ael05HAc,2770
-aws_annoying-0.8.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-aws_annoying-0.8.2.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
-aws_annoying-0.8.2.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
-aws_annoying-0.8.2.dist-info/RECORD,,
+aws_annoying-0.8.3.dist-info/METADATA,sha256=OOSSpm2II-lNufjCR_ETHdsRpSMBxwWZ-VxyoOekUh8,2075
+aws_annoying-0.8.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+aws_annoying-0.8.3.dist-info/entry_points.txt,sha256=DcKE5V0WvVJ8wUOHxyUz1yLAJOuuJUgRPlMcQ4O7jEs,66
+aws_annoying-0.8.3.dist-info/licenses/LICENSE,sha256=Q5GkvYijQ2KTQ-QWhv43ilzCno4ZrzrEuATEQZd9rYo,1067
+aws_annoying-0.8.3.dist-info/RECORD,,