aws-annoying 0.8.1__tar.gz → 0.8.3__tar.gz

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-  "name": "lasuillard/aws-annoying",
+  "name": "lasuillard-s/aws-annoying",
   "dockerComposeFile": [
     "./docker-compose.devcontainer.yaml"
   ],
@@ -23,7 +23,6 @@
         "tamasfe.even-better-toml",
         "streetsidesoftware.code-spell-checker",
         "EditorConfig.EditorConfig",
-        "VisualStudioExptTeam.vscodeintellicode",
         "charliermarsh.ruff",
         "ms-python.mypy-type-checker",
         "njpwerner.autodocstring",

aws_annoying-0.8.3/.github/workflows/devcf_ci.yaml

@@ -0,0 +1,101 @@
+name: Dev Container Features - CI
+
+on:
+  workflow_dispatch:
+  push:
+    tags: [v*]
+    paths:
+      - devcontainer-features/**
+
+  pull_request:
+    paths:
+      - devcontainer-features/**
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v6
+      - uses: devcontainers/action@v1
+        with:
+          validate-only: true
+          base-path-to-features: ./devcontainer-features/src
+
+  test-autogenerated:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        base-image:
+          - debian:latest
+        features:
+          - session-manager-plugin
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Dev Containers CLI
+        run: npm install --global @devcontainers/cli
+
+      - name: Run autogenerated tests
+        run: |
+          devcontainer features test \
+            --skip-scenarios \
+            --features '${{ matrix.features }}' \
+            --base-image '${{ matrix.base-image }}' \
+            ./devcontainer-features
+
+  test-scenarios:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        base-image:
+          - debian:latest
+        features:
+          - session-manager-plugin
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Dev Containers CLI
+        run: npm install --global @devcontainers/cli
+
+      - name: Run scenario tests
+        run: |
+          devcontainer features test \
+            --skip-autogenerated \
+            --skip-duplicated \
+            --features '${{ matrix.features }}' \
+            --base-image '${{ matrix.base-image }}' \
+            ./devcontainer-features
+
+  test-global:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        base-image:
+          - debian:latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Dev Containers CLI
+        run: npm install --global @devcontainers/cli
+
+      - name: Run global tests
+        run: |
+          devcontainer features test \
+            --global-scenarios-only \
+            --base-image '${{ matrix.base-image }}' \
+            ./devcontainer-features

aws_annoying-0.8.3/.github/workflows/devcf_release.yaml

@@ -0,0 +1,46 @@
+name: Dev Container Features - Release & Docs
+
+on:
+  workflow_dispatch:
+
+  # Every time when push changes to target directory, it will trigger release
+  # but the CLI won't overwrite existing published features unless the version is updated
+  push:
+    branches: [main]
+    paths:
+      - devcontainer-features/**
+
+jobs:
+  release:
+    if: ${{ (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main') || github.event_name == 'push' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write
+      pull-requests: write
+      packages: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: devcontainers/action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          publish-features: true
+          base-path-to-features: ./devcontainer-features/src
+          generate-docs: true
+
+      - name: Generate GitHub App token
+        uses: actions/create-github-app-token@v2
+        id: generate-token
+        with:
+          app-id: ${{ vars.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - name: Create PR for generated docs
+        uses: peter-evans/create-pull-request@v8.0.0
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          sign-commits: true
+          title: Automated documentation update
+          branch: automated-documentation-update-${{ github.run_id }}
+          delete-branch: true

aws_annoying-0.8.1/.github/workflows/ci.yaml → aws_annoying-0.8.3/.github/workflows/main_ci.yaml

@@ -6,21 +6,18 @@ on:
   pull_request:
     branches: [main]
 
-permissions: read-all
-
 env:
   UV_FROZEN: 1
 
 jobs:
   lint:
-    name: Lint
     runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: read
     steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-
-      - name: Set up uv
-        uses: astral-sh/setup-uv@v6
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
         with:
           version: latest
           enable-cache: true
@@ -36,8 +33,9 @@ jobs:
         if: always()
 
   test:
-    name: Test (${{ matrix.os }}, Python ${{ matrix.python-version }})
+    name: test (${{ matrix.os }}, py${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
     permissions:
       contents: read
       id-token: write
@@ -48,11 +46,8 @@ jobs:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-
-      - name: Set up uv
-        uses: astral-sh/setup-uv@v6
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
         with:
           version: latest
           enable-cache: true
@@ -82,10 +77,10 @@ jobs:
         run: |
           Get-Command session-manager-plugin | Out-String -Width 2000
 
-          $uri = 'https://s3.amazonaws.com/session-manager-downloads/plugin/latest/windows/SessionManagerPluginSetup.exe'
-          $outFile = 'C:\Windows\Temp\SessionManagerPluginSetup.exe'
+          $uri = 'https://raw.githubusercontent.com/aws/session-manager-plugin/refs/heads/mainline/Tools/src/update/windows/uninstall.bat'
+          $outFile = 'C:\Windows\Temp\uninstall.bat'
           Invoke-WebRequest -Uri "$uri" -OutFile "$outFile"
-          & "$outFile" /uninstall /quiet
+          & "$outFile"
 
           uv run pytest -m 'not docker'
 

aws_annoying-0.8.3/.github/workflows/main_docs.yaml

@@ -0,0 +1,41 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+
+concurrency:
+  group: docs
+  cancel-in-progress: false
+
+env:
+  UV_FROZEN: 1
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          version: latest
+          enable-cache: true
+
+      - name: Install deps
+        run: uv sync
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "github-actions[bot]@github.com"
+          git config --local user.name "GitHub Action"
+
+      - name: Build docs
+        run: |
+          uv run mike deploy --push "${{ github.ref_name }}"

aws_annoying-0.8.3/.github/workflows/main_prepare-release.yaml

@@ -0,0 +1,51 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Semver-style tag for release (e.g., v1.0.0)
+        required: true
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Check tag format
+        run: |
+          if [[ ! "${{ inputs.tag }}" =~ ^v ]]; then
+            echo "Tag must start with 'v'"
+            exit 1
+          fi
+
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          version: latest
+          enable-cache: true
+
+      - name: Set version
+        run: |
+          tag="${{ inputs.tag }}"
+          tag_no_v="${tag#v}"
+          uv version "${tag#v}"
+
+      - name: Generate GitHub App token
+        uses: actions/create-github-app-token@v2
+        id: generate-token
+        with:
+          app-id: ${{ vars.GH_APP_ID }}
+          private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v8.0.0
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          sign-commits: true
+          title: Release ${{ inputs.tag }}
+          branch: release/${{ inputs.tag }}
+          delete-branch: true

aws_annoying-0.8.1/.github/workflows/release.yaml → aws_annoying-0.8.3/.github/workflows/main_release.yaml

@@ -1,24 +1,21 @@
 name: Release
 
 on:
-  push:
-    tags: [v*]
+  release:
+    types: [published]
 
 env:
   UV_FROZEN: 1
 
 jobs:
   release:
-    name: Release
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     permissions:
       contents: write
     steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-
-      - name: Set up uv
-        uses: astral-sh/setup-uv@v6
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
         with:
           version: latest
           enable-cache: true
@@ -30,31 +27,39 @@ jobs:
         run: uv build
 
       - name: Create release
-        uses: softprops/action-gh-release@v2
+        uses: softprops/action-gh-release@v2.5.0
         with:
+          tag_name: ${{ github.event.release.tag_name }}
           generate_release_notes: true
           files: dist/*
 
+      - name: Show files
+        run: ls -l --all --recursive dist
+
       - name: Upload release distributions
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: release-dists
           path: dist/
 
   publish-pypi:
-    name: Publish to PyPI
+    needs: release
     runs-on: ubuntu-latest
-    needs:
-      - release
+    environment: pypi
+    timeout-minutes: 5
     permissions:
       id-token: write
-    environment: pypi
     steps:
-      - name: Retrieve release distributions
-        uses: actions/download-artifact@v5
+      - name: Download release distributions
+        uses: actions/download-artifact@v7
         with:
           name: release-dists
           path: dist/
 
+      - name: Show artifacts
+        run: ls -l --all --recursive dist
+
       - name: Publish release distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/.pre-commit-config.yaml

@@ -8,30 +8,17 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
 
-  - repo: https://github.com/lasuillard/pre-commit-hooks
-    rev: v0.4.1
+  - repo: https://github.com/lasuillard-s/devobs
+    rev: v0.2.1
     hooks:
-      - id: source-matching-test
+      - id: check-file-pair
         args:
-          - --source
-          - aws_annoying
+          - --from=pulumi_extra
+          - --to=tests
+          - --include=*.py
+          - --exclude=utils/debugger.py,_*.py
+          - --expect={to}/{relative_from}/test_{filename}
           - --create-if-not-exists
-          - --extend-exclude
-          - utils/debugger.py
-          - --extend-exclude
-          - "**/_*.py"
-      - id: test-matching-source
-        args:
-          - --target
-          - aws_annoying
-          - --extend-exclude
-          - "**/conftest.py"
-          - --extend-exclude
-          - "**/_*/**/*.py"
-          - --extend-exclude
-          - "**/_*.py"
-      - id: preferred-suffix
-        args: [--rename]
 
   - repo: local
     hooks:

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/.vscode/extensions.json

@@ -4,7 +4,6 @@
     "ms-python.vscode-pylance",
     "streetsidesoftware.code-spell-checker",
     "editorconfig.editorconfig",
-    "visualstudioexptteam.vscodeintellicode",
     "charliermarsh.ruff",
     "ms-python.mypy-type-checker",
     "ms-python.debugpy"

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/.vscode/settings.json

@@ -9,10 +9,12 @@
   "cSpell.words": [
     "Deregistering",
     "localstack",
+    "pydantic",
     "pytestmark",
     "sessionmanagerplugin",
     "Stubber",
-    "Tampermonkey"
+    "Tampermonkey",
+    "Typer"
   ],
   "editor.formatOnSave": true,
   "files.eol": "\n",

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/Makefile

@@ -28,6 +28,11 @@ update:  ## Update deps and tools
 	pre-commit autoupdate
 .PHONY: update
 
+serve-docs:  ## Serve documentation with live reload
+	uv run mkdocs serve \
+		--dev-addr "$$([ -n "$${CONTAINER:-}" ] && echo '0.0.0.0:8000' || echo '127.0.0.1:8000')"
+.PHONY: serve-docs
+
 
 # =============================================================================
 # CI

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: aws-annoying
-Version: 0.8.1
+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
@@ -19,8 +19,7 @@ Description-Content-Type: text/markdown
 # aws-annoying
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![CI](https://github.com/lasuillard/aws-annoying/actions/workflows/ci.yaml/badge.svg)](https://github.com/lasuillard/aws-annoying/actions/workflows/ci.yaml)
-[![codecov](https://codecov.io/gh/lasuillard/aws-annoying/graph/badge.svg?token=gbcHMVVz2k)](https://codecov.io/gh/lasuillard/aws-annoying)
+[![codecov](https://codecov.io/gh/lasuillard-s/aws-annoying/graph/badge.svg?token=gbcHMVVz2k)](https://codecov.io/gh/lasuillard-s/aws-annoying)
 [![PyPI - Version](https://img.shields.io/pypi/v/aws-annoying)](https://pypi.org/project/aws-annoying/)
 
 Utils to handle some annoying AWS tasks.
@@ -34,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
 
@@ -52,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.3/README.md

@@ -0,0 +1,41 @@
+# aws-annoying
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![codecov](https://codecov.io/gh/lasuillard-s/aws-annoying/graph/badge.svg?token=gbcHMVVz2k)](https://codecov.io/gh/lasuillard-s/aws-annoying)
+[![PyPI - Version](https://img.shields.io/pypi/v/aws-annoying)](https://pypi.org/project/aws-annoying/)
+
+Utils to handle some annoying AWS tasks.
+
+## ❓ About
+
+This project aims to provide a set of utilities and examples to help with some annoying tasks when working with AWS.
+
+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
+
+It is recommended to use [pipx](https://pipx.pypa.io/stable/) to install `aws-annoying` CLI:
+
+```bash
+$ pipx install aws-annoying
+$ aws-annoying --help
+
+ Usage: aws-annoying [OPTIONS] COMMAND [ARGS]...
+
+...
+```
+
+As the package also provides some utility functions, you can install `aws-annoying` via pip, if you are going to use those utils.
+
+## 💡 Usage
+
+Refer to the CLI help or documentation for detailed information on how to use each command.
+
+## 💖 Contributing
+
+Any feedback, suggestions or contributions are welcome! Feel free to open an issue or a pull request.

{aws_annoying-0.8.1 → aws_annoying-0.8.3}/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-0.8.1 → aws_annoying-0.8.3}/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-0.8.1 → aws_annoying-0.8.3}/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):