AWS-Mu 0.20250611.3__tar.gz

aws_mu-0.20250611.3/.ci/.gitignore

@@ -0,0 +1,2 @@
+artifacts
+test-reports

aws_mu-0.20250611.3/.ci/pytest.ini

@@ -0,0 +1,7 @@
+[pytest]
+# default value for pytest 6.0 and specifying it avoids a deprecation warning
+junit_family=xunit2
+filterwarnings =
+    # Any errors not noted here should cause pytest to throw an error. It seems like this should be
+    # last in the list, but warnings that match multiple lines will apply the last line matched.
+    error

aws_mu-0.20250611.3/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2
+jobs:
+    build:
+        docker:
+            - image: level12/python-test-multi
+            - image: postgres:13
+              environment:
+                # Ok for CI, potentially UNSAFE in other applications.  Don't blindly copy & paste
+                # without considering implications.
+                POSTGRES_HOST_AUTH_METHOD: trust
+        steps:
+            - checkout
+
+            - run:
+                name: debugging info
+                command: |
+                    ls -al
+
+            - run:
+                name: install testing helpers needed at OS level
+                command: >
+                    python3.9 -m pip install --upgrade --force-reinstall --quiet tox
+
+            - run:
+                name: version checks
+                command: |
+                    python3.9 --version
+                    python3.9 -m tox --version
+
+            - run:
+                name: run tox
+                command: python3.9 -m tox
+
+            - store_test_results:
+                path: .ci/test-reports/
+
+            - run:
+                name: push code coverage
+                command: bash <(curl -s https://codecov.io/bash) -X coveragepy -t

aws_mu-0.20250611.3/.copier-answers-py.yaml

@@ -0,0 +1,19 @@
+# Changes here will be overwritten by Copier
+#
+# Updating `_src` could be helpful, see notes at:
+# https://github.com/level12/coppy/wiki#creating-a-project
+#
+# Otherwise, NEVER EDIT MANUALLY
+_commit: v1.20250523.1
+_src_path: gh:level12/coppy
+author_email: randy.syring@level12.io
+author_name: Randy Syring
+gh_org: level12
+gh_repo: mu
+hatch_version_tag_sign: true
+project_name: Mu
+py_module: mu
+python_version: '3.13'
+script_name: mu
+use_circleci: false
+use_gh_nox: true

aws_mu-0.20250611.3/.coveragerc

@@ -0,0 +1,18 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # testing assertions usually used with exceptions
+    assert False
+
+    # patterns for running cli
+    cli_entry()
+
+[html]
+directory = ci/coverage-html

aws_mu-0.20250611.3/.dockerignore

@@ -0,0 +1,6 @@
+./events
+./misc
+./requirements
+./*.*
+*.pyc
+.git

aws_mu-0.20250611.3/.editorconfig

@@ -0,0 +1,38 @@
+# This is the "top-most" .editorconfig for this project.
+# Like a `.gitignore` file, you can place additional
+# .editorconfig files in specific directories, if you need
+# local settings. However, this directive specifies that
+# no "global" settings will be used (settings from higher-
+# up in the directory hierarchy, wherever that may be)
+root = true
+
+# Set the default whitespace settings for all files
+[*]
+
+# Use UNIX-style line endings
+end_of_line = lf
+
+# 4-space indents
+indent_size = 4
+indent_style = space
+
+# end all files with a newline
+insert_final_newline = true
+
+# trim whitespace from the ends of lines
+trim_trailing_whitespace = true
+
+
+[*.py]
+# ensure Python source files are utf-8
+charset = utf-8
+
+
+[*.{yml,yaml}]
+# Set two-space indents for YAML files
+indent_size = 2
+
+
+[Makefile]
+# Makefiles *must* use tabs!
+indent_style = tab

aws_mu-0.20250611.3/.github/workflows/nox.yaml

@@ -0,0 +1,47 @@
+name: Nox
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+# Limit this workflow to a single run at a time per-branch to avoid wasting worker resources
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  nox:
+    runs-on: ubuntu-latest
+
+    # Runs all steps inside this container
+    container:
+      image: ghcr.io/level12/ubuntu-mive:24-3.12
+      options: --user root
+
+    env:
+      UV_LINK_MODE: copy
+      MU_TEST_ACCT_ID: '429829037495'
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Mark repo as safe for Git
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::429829037495:role/mu-github-ci-role
+          aws-region: us-east-2
+
+      - name: Run Tests
+        run: |
+          uv run --only-group nox -- nox

aws_mu-0.20250611.3/.github/workflows/pypi.yaml

@@ -0,0 +1,60 @@
+# Example:
+#  - https://github.com/pallets/flask/blob/main/.github/workflows/tests.yaml
+# TODO:
+# GH release
+# Environment protection
+#  - https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment
+# Separate build & release
+
+name: PyPI publish
+
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    name: Build and publish
+
+    runs-on: ubuntu-latest
+
+    # TODO: recommended best practice
+    # environment:
+    #   name: pypi-publish
+    #   url: https://pypi.org/p/mu
+
+    permissions:
+      # required for pypa/gh-action-pypi-publish
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v4
+
+    # https://docs.astral.sh/uv/guides/integration/github/#setting-up-python
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+
+    - name: Python prep & build
+      run: |
+        uv sync --locked
+
+        uv run hatch --version
+
+        echo "Project version: `uv run hatch version`"
+
+        uv run hatch build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

aws_mu-0.20250611.3/.gitignore

@@ -0,0 +1,39 @@
+# Python
+*.pyc
+*.egg-info
+.venv
+
+# Tox/Nox/Tests/Coverage
+/.nox
+/.tox
+/ci/coverage-html
+*.coverage
+/coverage.xml
+*.pytests.xml
+.pytest_cache
+
+
+# Editor Clutter
+.vscode
+.idea
+
+
+# Build related
+dist
+/build
+npm-debug.log
+.*-cache
+node_modules
+
+
+# Local dev files
+/mise.local.toml
+/tmp
+
+# Terraform
+*.tfstate*
+tf.plan
+.terraform
+
+
+# Project specific

aws_mu-0.20250611.3/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-ast
+        types: [ python ]
+      - id: debug-statements
+        types: [ python ]
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-yaml
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.11.13
+    hooks:
+      # i.e. `ruff check`
+      - id: ruff
+      # i.e. `ruff format --check`
+      - id: ruff-format
+        # Due to the Ruff config we use (see comment in pyproject.yaml), it's possible that the
+        # formatter creates linting failures. By only doing a check here, it forces the dev to run
+        # the formatter before pre-commit runs (presumably on save through their editor) and then
+        # the linting check above would always catch a problem created by the formatter.
+        args: [ --check ]
+  - repo: https://github.com/level12/pre-commit-hooks
+    rev: v0.20250226.1
+    hooks:
+      - id: check-ruff-versions
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.12
+    hooks:
+      - id: uv-lock

aws_mu-0.20250611.3/.python-version

@@ -0,0 +1 @@
+3.13

aws_mu-0.20250611.3/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: aws-mu
+Version: 0.20250611.3
+Author-email: Randy Syring <randy.syring@level12.io>
+Requires-Python: >=3.12
+Requires-Dist: arrow>=1.3.0
+Requires-Dist: awsgi2>=1.0.2
+Requires-Dist: blazeutils>=0.7.0
+Requires-Dist: boto3>=1.38.34
+Requires-Dist: click>=8.2.1
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: cryptography>=45.0.4
+Requires-Dist: docker>=7.1.0
+Requires-Dist: methodtools>=0.4.7
+Requires-Dist: requests>=2.32.4
+Description-Content-Type: text/markdown
+
+# Mu
+[![nox](https://github.com/level12/mu/actions/workflows/nox.yaml/badge.svg)](https://github.com/level12/mu/actions/workflows/nox.yaml)
+
+AWS Lambda support for Python projects.
+
+## Project Setup
+
+To use mu, a project needs a `pyproject.toml` and either
+
+1. a `mu.toml` in the same directory (takes precedence); or
+2. `tools.mu` sections in the `pyproject.toml`
+
+It also needs
+
+* Dockerfile
+* compose.yaml (or docker-compose.yaml if you insist)
+* An entry point in the app for the lambda events
+
+An example application with these required elements can be found at:
+[mu_hello](https://github.com/level12/mu/tree/master/mu_hello)
+
+
+## Usage: Local
+
+Let's demonstrate usage with [`mu_hello`](https://github.com/level12/mu/tree/master/mu_hello).
+Assuming you have copied that source locally and are in the directory:
+
+```shell
+$ mu build
+$ docker compose up mu-hello
+
+# Watch current shell for log output and, in a new shell, run:
+$ mu invoke --local
+```
+
+That command should have output like:
+```
+{'context': {'aws_request_id': '83fd7a58-5f6d-45e1-8092-b509c4f60898',
+             'function_name': 'test_function',
+             'function_version': '$LATEST',
+             'invoked_function_arn': 'arn:aws:lambda:us-east-1:012345678912:function:test_function',
+             'log_group_name': '/aws/lambda/Functions',
+             'log_stream_name': '$LATEST',
+             'memory_limit_in_mb': '3008',
+             'remaining_time': 299967},
+ 'error': None,
+ 'event': {'action-args': [], 'do-action': 'diagnostics'}}
+```
+
+And the first shell should have output like:
+
+```
+11 Jun 2024 19:28:28,809 [INFO] (rapid) INIT START(type: on-demand, phase: init)
+...
+11 Jun 2024 19:28:28,843 [INFO] (rapid) INVOKE RTDONE(status: success, produced bytes: 0, duration: 0.724000ms)
+```
+
+Now invoke the hello command:
+
+```sh
+$ mu invoke --local hello
+'Hello World from mu_hello'
+
+# with arguments
+$ mu invoke --local hello 'Capt. Picard'
+'Hello Capt. Picard from mu_Hello'
+
+# call a Click command
+$ mu invoke --local cli
+47
+
+# And you should see the following in the docker shell
+'Hello Alpha Quadrant from mu_Hello'
+```
+
+## Usage: AWS
+
+
+This is assuming you are (still) in the `mu_hello` directory and have AWS auth setup.  `aws sts
+get-caller-identity` should be working.
+
+```sh
+Verify AWS auth:
+$ mu auth-check
+Account: 429812345678
+Region: us-east-2
+Organization owner: you@example.com
+```
+
+Note that mu has the concept of an "environment" which is used when naming objects to support
+provision and deployment for beta, prod, etc.  There is a default environment that is part of the
+mu config and defaults to `you.your-host`.
+
+
+```sh
+# Ensure IAM and ECR infra. is in place for the enterprise environment
+$ mu provision enterprise
+    info  Role created: starfleet-mu-hello-lambda-enterprise
+    info  Policy created: starfleet-mu-hello-lambda-enterprise-logs
+    info  Policy created: starfleet-mu-hello-lambda-enterprise-ecr-repo
+    info  Repository created: starfleet-mu-hello-enterprise
+    info  Waiting 0.1s for role to be ready
+    info  Waiting 0.25s for role to be ready
+    ...[snip]...
+    info  Provision finished for env: enterprise
+
+# Build and push image, setup aws lambda
+$ mu deploy --build enterprise
+    info  docker compose build --pull
+[+] Building 0.3s (10/10)
+...[snip docker output]...
+    info  Tagged, pushing...
+    info  Tagged and pushed: 429829037495.dkr.ecr.us-east-2.amazonaws.com/starfleet-mu-hello-enterprise mu-hello-2024-06-11T21.31.09
+    info  Deploying: 429829037495.dkr.ecr.us-east-2.amazonaws.com/starfleet-mu-hello-enterprise:mu-hello-2024-06-11T21.31.09
+    info  Lambda function created: starfleet-mu-hello-handler-enterprise
+    info  Function arn: arn:aws:lambda:us-east-2:429829037495:function:starfleet-mu-hello-handler-enterprise
+    info  Waiting for lambda to be updated: starfleet-mu-hello-handler-enterprise
+
+
+$ mu invoke --env enterprise
+{'context': {'aws_request_id': 'cc44e34f-b7f1-4f2a-a314-e4dd2513b229'
+...[snip]...
+```
+
+
+## Usage: Async Tasks
+
+Async task workers without a broker/queue:
+
+```python
+from flask import Flask
+import mu
+
+app = Flask(__name__)
+
+
+@mu.task
+def ping_task(a, *, b):
+    print('ping_task()', a, b)
+
+
+@app.route('/ping')
+def ping():
+    # ping_task() will be called through async lambda invokation
+    ping_task.invoke(1, b=2)
+    return 'ok'
+
+
+@mu.task(lambda_func='this-app-bigger-lambda')
+def crunch_big_numbers(a, b, c):
+    """ You can change the lambda name but it still needs to be this app.  """
+    print('crunch_big_numbers()', a, b, c)
+
+```
+
+Be mindeful of:
+
+- [async invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html)
+- [retries](https://docs.aws.amazon.com/lambda/latest/dg/invocation-retries.html)
+
+
+## Dev
+
+### Copier Template
+
+Project structure and tooling mostly derives from the [Coppy](https://github.com/level12/coppy),
+see its documentation for context and additional instructions.
+
+This project can be updated from the upstream repo, see
+[Updating a Project](https://github.com/level12/coppy?tab=readme-ov-file#updating-a-project).
+
+### Project Setup
+
+From zero to hero (passing tests that is):
+
+1. Ensure [host dependencies](https://github.com/level12/coppy/wiki/Mise) are installed
+
+2. Sync [project](https://docs.astral.sh/uv/concepts/projects/) virtualenv w/ lock file:
+
+   `uv sync`
+
+3. Configure pre-commit:
+
+   `pre-commit install`
+
+4. Run tests w/ `nox` or `pytest` but see notes just below first.
+
+
+### Testing
+
+#### Credentials
+
+This project has a lot of integration tests that use live AWS.  You SHOULD have a dedicated AWS
+**account** for mu testing.
+
+An [env-config](https://github.com/level12/env-config) config is present which will use aws-vault
+and a "mu-test" profile to load AWS creds.  But, you can use any method you prefer to setup
+[credentials for boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).
+
+
+#### Running tests
+
+- Setup AWS credentials (see notes above)
+- Add `mise.local.toml` to override `MU_TEST_ACCT_ID`
+- `nox` or `pytest`
+- Some integration tests are marked as such (other integration tests should get marked)
+   - `pytest -m 'not integration'` ...` will skip integration tests
+   - `pytest -m 'integration'` ...` will target integration tests
+
+
+### Versions
+
+Versions are date based.  A `bump` action exists to help manage versions:
+
+```shell
+
+  # Show current version
+  mise bump --show
+
+  # Bump version based on date, tag, and push:
+  mise bump
+
+  # See other options
+  mise bump -- --help
+```

aws_mu-0.20250611.3/ci/.gitignore

@@ -0,0 +1,2 @@
+artifacts
+test-reports

aws_mu-0.20250611.3/env-config.yaml

@@ -0,0 +1,28 @@
+# Example AWS CONFIG
+#
+#
+# [profile example-org]
+# region = us-east-2
+# output = json
+# mfa_serial = arn:aws:iam::...
+# credential_process = env-config-aws example-org
+# envconfig_1pass = op://example-org/Employee/aws-secrets-item
+
+# [profile mu-test]
+# source_profile = example-org
+# role_arn = arn:aws:iam::429829037495:role/OrganizationAccountAccessRole
+# region = us-east-2
+
+# [profile mu-ci]
+# source_profile = example-org
+# role_arn = arn:aws:iam::429829037495:role/mu-github-ci-role
+# region = us-east-2
+
+profile:
+  aws-mu-test:
+    AWS_PROFILE: mu-test
+  aws-mu-ci:
+    AWS_PROFILE: mu-ci
+  pypi:
+    HATCH_INDEX_USER: '__token__'
+    HATCH_INDEX_AUTH: 'op://private/pypi.python.org/api-token'

aws_mu-0.20250611.3/examples/apprunner/Dockerfile

@@ -0,0 +1,20 @@
+FROM public.ecr.aws/lambda/python:3.12
+
+WORKDIR ${LAMBDA_TASK_ROOT}
+
+# Install the apps's dependencies.  This should include mu.
+COPY requirements.txt /tmp/requirements.txt
+
+# Its deliberate that this is below requirements.  It means these packages will
+# get updated every time our apps' packages get updated.
+RUN pip install --break-system-packages -U pip uv
+
+RUN uv pip install --python=/var/lang/bin/python --no-cache-dir -r /tmp/requirements.txt
+
+# Now everything to do with the app
+COPY app.py ./
+
+# Uncomment this to get the CMD to be updated in the image.
+# RUN echo 'd' > /tmp/annoying.txt
+
+CMD ["app.lambda_handler"]

aws_mu-0.20250611.3/examples/apprunner/app.py

@@ -0,0 +1,50 @@
+import logging
+from os import environ
+
+import boto3
+from flask import Flask
+
+import mu
+
+
+log = logging.getLogger()
+
+app = Flask(__name__)
+
+
+@app.route('/')
+def hello_world():
+    return '<p>Hello, <strong>World</strong>!</p>'
+
+
+@app.route('/sqs')
+def sqs():
+    sqs = boto3.client('sqs', region_name='us-east-2')
+    queue_prefix = environ.get('MU_RESOURCE_IDENT')
+    queue_name = f'{queue_prefix}-celery'
+    response = sqs.get_queue_url(QueueName=queue_name)
+
+    return str((response.get('QueueUrl'), environ.get('MU_ENV')))
+
+
+@app.route('/log')
+def logs_example():
+    log.error('This is an error')
+    log.warning('This is a warning')
+    log.info('This is an info log')
+    log.debug('This is a debug log')
+
+    return 'Logs emitted at debug, info, warning, and error levels'
+
+
+@app.route('/error')
+def error():
+    raise RuntimeError('Deliberate runtime error')
+
+
+class ActionHandler(mu.ActionHandler):
+    wsgi_app = app
+
+
+# The entry point for AWS lambda has to be a function
+lambda_handler = ActionHandler.on_event

aws_mu-0.20250611.3/examples/apprunner/compose.yaml

@@ -0,0 +1,18 @@
+services:
+  app:
+    image: mu-flask:latest
+    container_name: mu-flask
+    # The build key is important is it keeps our local docker building new images when changes
+    # are made to the project.  Without it, once its built, it will keep using the image
+    # currently in docker.
+    build:
+      context: ../..
+      dockerfile: examples/flask/Dockerfile
+    ports:
+      - "127.0.0.1:8080:8080"
+  # Use this with `docker compose run` if you need to explore the AWS python image
+  runnable:
+    image: mu-flask:latest
+    entrypoint: /bin/bash
+    tty: true
+    stdin_open: true