cdk-factory 0.0.1__tar.gz

cdk_factory-0.0.1/.gitignore

@@ -0,0 +1,178 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+
+# aws cdk ignores
+cdk.out
+
+# mac os file
+.DS_store

cdk_factory-0.0.1/.vscode/launch.json

@@ -0,0 +1,83 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [        
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/src/cdk_factory",
+                "RUN_INTEGRATION_TESTS": "True"
+                
+               
+            }
+        },
+        {
+            "name": "CDK Synth with Python Args",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/cdk_factory/app.py",
+            "console": "integratedTerminal",
+            "args": ["-c", "config=path/to/config.json"],
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/src/cdk_factory",
+                "RUN_INTEGRATION_TESTS": "True"                           
+            }
+        },
+        {
+            "name": "CDK Synth with CDK Args",
+            "type": "node",
+            "request": "launch",
+            "program": "/Users/eric.wilson/.nvm/versions/node/v20.9.0/bin/cdk",
+            "console": "integratedTerminal",
+            "args": [
+                "synth",
+                "-a",
+                "python",
+                "${workspaceFolder}/src/cdk_factory/app.py",
+                "-c", "config=path/to/config.json"],
+            "env": {
+                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/src/cdk_factory",
+                "RUN_INTEGRATION_TESTS": "True"
+                
+               
+            }
+        },
+        {
+            "name": "CDK Synth: Static WebSite",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/examples/website/static_website/devops/app.py",
+            "console": "integratedTerminal",           
+            "env": {                
+                "ENVRIONMENT": "dev",
+                "DEBUG_MODE": "True",
+                "PYTHONPATH": "${workspaceFolder}:${workspaceFolder}/src:${workspaceFolder}/src/cdk_factory",
+                "RUN_INTEGRATION_TESTS": "True"                   
+            }
+        },
+        {
+            "name": "Build & Deploy Artifacts",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/devops/build.py",
+            "console": "integratedTerminal"
+        },
+        
+    ]
+}

cdk_factory-0.0.1/.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+    
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "*test.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.analysis.typeCheckingMode": "off",
+    "python.analysis.extraPaths": [                
+        "${workspaceFolder}/src",
+        "${workspaceFolder}/tests",
+        "${workspaceFolder}/examples",
+        "${workspaceFolder}/examples/website"
+    ],
+    "[python]": {
+        
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        },
+        "editor.defaultFormatter": "charliermarsh.ruff",
+    },
+    
+}

cdk_factory-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Geek Cafe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cdk_factory-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: cdk_factory
+Version: 0.0.1
+Summary: CDK Factory. A QuickStarter and best practices setup for CDK projects
+Author-email: Eric Wilson <eric.wilson@geekcafe.com>
+License: MIT License
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: aws-cdk-lib
+Requires-Dist: aws-lambda-powertools>=2.38.1
+Requires-Dist: boto3-assist
+Requires-Dist: constructs
+Description-Content-Type: text/markdown
+
+# cdk-factory
+An AWS CDK wrapper for common deployments

cdk_factory-0.0.1/README.md

@@ -0,0 +1,2 @@
+# cdk-factory
+An AWS CDK wrapper for common deployments

cdk_factory-0.0.1/devops/build.py

@@ -0,0 +1,118 @@
+import json
+import os
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List
+
+import toml
+from aws_lambda_powertools import Logger
+
+logger = Logger()
+
+
+def main():
+    """build the artifacts"""
+    project_root = Path(__file__).parent.parent
+
+    # extact the version
+    pyproject_toml = os.path.join(project_root, "pyproject.toml")
+    version_file = os.path.join(project_root, "src", "cdk_factory", "version.py")
+    extract_version_and_write_to_file(pyproject_toml, version_file)
+    # do the build
+    run_local_clean_up()
+
+    run_build()
+    run_publish()
+
+
+def run_local_clean_up():
+    """run a local clean up and remove older items in the dist directory"""
+    root = Path(__file__).parent.parent
+    dist_dir = os.path.join(root, "dist")
+    if os.path.exists(dist_dir):
+        # clear it out
+        shutil.rmtree(dist_dir)
+
+
+def run_remote_clean_up():
+    """
+    Clean out older versions
+    """
+    logger.warning("warning/info: older versions are not being cleaned out.")
+
+
+def extract_version_and_write_to_file(pyproject_toml: str, version_file: str):
+    """
+    extract the version number from the pyproject.toml file and write it
+    to the version.py file
+    """
+    if not os.path.exists(pyproject_toml):
+        raise FileNotFoundError(
+            f"The pyproject.toml file ({pyproject_toml}) not found. "
+            "Please check the path and try again."
+        )
+
+    with open(pyproject_toml, "r", encoding="utf-8") as file:
+        pyproject_data = toml.load(file)
+        version = pyproject_data["project"]["version"]
+        with open(version_file, "w", encoding="utf-8") as f:
+            f.write(f"__version__ = '{version}'\n")
+
+
+def run_build():
+    """Run python build commands"""
+    run_commands(["python", "-m", "build"])
+
+
+def run_publish():
+    """publish to code artifact"""
+
+    # Set up the environment variables for the upload command
+    api_token = os.getenv("PYPI_API_TOKEN")
+
+    if not api_token:
+        raise ValueError("PYPI_API_TOKEN environment variable is not set.")
+
+    env = os.environ.copy()
+    env["TWINE_USERNAME"] = "__token__"
+    env["TWINE_PASSWORD"] = api_token
+
+    run_commands(
+        ["python", "-m", "twine", "upload", "dist/*"],
+        env=env,
+    )
+
+
+def get_url(payload: str):
+    """get the url from the payload"""
+    value: dict = json.loads(payload)
+    url = value.get("repositoryEndpoint")
+
+    return url
+
+
+def run_commands(
+    commands: List[str], capture_output: bool = False, env=None
+) -> str | None:
+    """centralized area for running process commands"""
+    try:
+        # Run the publish command
+        result = subprocess.run(
+            commands,
+            check=True,
+            capture_output=capture_output,
+            env=env,  # pass any environment vars
+        )
+
+        if capture_output:
+            output = result.stdout.decode().strip()
+            print(output)
+            return output
+
+    except subprocess.CalledProcessError as e:
+        logger.exception(f"An error occurred: {e}")
+
+
+if __name__ == "__main__":
+    main()

cdk_factory-0.0.1/devops/readme.md

@@ -0,0 +1,23 @@
+# DevOps
+
+## building
+```sh
+
+```
+
+## deploying
+
+```sh
+twine upload dist/*
+
+```
+
+## uploading and testing with a "test"
+
+```sh
+
+twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+pip install --index-url https://test.pypi.org/simple/ boto3-assist
+
+```

cdk_factory-0.0.1/examples/website/README.md

@@ -0,0 +1,8 @@
+# WebSite Pipeline
+
+This sample deploys an AWS CodePipeline, which will do the following
+
+1. Builds the AWS CodePipeline
+2. Connects to a repo like GitHub, AWS CodeCommit, etc
+3. The first time this is runs CodePipeline also runs
+4. Subsequent check-ins will run the Pipeline

cdk_factory-0.0.1/examples/website/static_website/README.md

@@ -0,0 +1,6 @@
+
+
+```sh
+pip install --upgrade pip hatchling
+pip install -e .
+```

cdk_factory-0.0.1/examples/website/static_website/devops/__paths__.py

@@ -0,0 +1,12 @@
+import os
+import sys
+from pathlib import Path
+
+project_root = Path(__file__).parents[4].absolute()
+print(f"project root: {project_root}")
+## needed for discovery based top level execution
+sys.path.insert(0, os.path.join(project_root))
+sys.path.insert(0, os.path.join(project_root, "src"))
+sys.path.insert(0, os.path.join(project_root, "src", "cdk_factory"))
+sys.path.insert(0, os.path.join(project_root, "examples"))
+sys.path.insert(0, os.path.join(project_root, "examples", "website"))

cdk_factory-0.0.1/examples/website/static_website/devops/app.py

@@ -0,0 +1,62 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import os
+from pathlib import Path
+
+# import __paths__
+from cdk_factory.app import CdkAppFactory
+
+
+class MyStaticWebSiteApp:
+    """My Static WebSite Example"""
+
+    def __init__(self):
+        self.name = "MyApp"
+
+    def synth(self):
+        """Synth my static web site"""
+        print("synth", self.name)
+        path = str(Path(__file__).parent)
+        config_path = os.path.join(path, "config.json")
+        if not os.path.exists(config_path):
+            raise FileNotFoundError(config_path)
+
+        # the CdkAppFactory will use some "canned" or pre-made stacks
+        factory: CdkAppFactory = CdkAppFactory(config=config_path)
+
+        # this provides a way to inject stacks from this module
+        # stacks: Stacks = Stacks(app=factory.app)
+        # stacks.synth()
+
+        # something like this to add to the pipeline(s)
+        # factory.pipelines["dev"].stages.add("dev", stack=stacks.stacks)
+        cdk_app_file = "./examples/website/static_website/devops/app.py"
+        print(
+            "👉 Synthing - this runs local and then later in AWS if a self mutate happens"
+        )
+        print(
+            (
+                "🚨 Warning - be careful when adding paths.  You don't want to bake in a local path "
+                "or a runtime build path that gets carried over into the next build."
+            )
+        )
+
+        print("synth:synthing path:", cdk_app_file)
+        print("synth:file path", __file__)
+        print("synth: PWD", os.getenv("PWD"))
+
+        return factory.synth(paths=[path], cdk_app_file=cdk_app_file)
+
+
+def main():
+    """Run the app"""
+    app = MyStaticWebSiteApp()
+    app.synth()
+
+
+if __name__ == "__main__":
+    main()

cdk_factory-0.0.1/examples/website/static_website/devops/cdk.json

@@ -0,0 +1,64 @@
+{
+    "app": "python3 app.py",
+    "watch": {
+      "include": [
+        "**"
+      ],
+      "exclude": [
+        "README.md",
+        "cdk*.json",
+        "requirements*.txt",
+        "source.bat",
+        "**/__init__.py",
+        "**/__pycache__",
+        "tests"
+      ]
+    },
+    "context": {
+      "@aws-cdk/aws-lambda:recognizeLayerVersion": true,
+      "@aws-cdk/core:checkSecretUsage": true,
+      "@aws-cdk/core:target-partitions": [
+        "aws",
+        "aws-cn"
+      ],
+      "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+      "@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
+      "@aws-cdk/aws-ecs:arnFormatIncludesClusterName": true,
+      "@aws-cdk/aws-iam:minimizePolicies": true,
+      "@aws-cdk/core:validateSnapshotRemovalPolicy": true,
+      "@aws-cdk/aws-codepipeline:crossAccountKeyAliasStackSafeResourceName": true,
+      "@aws-cdk/aws-s3:createDefaultLoggingPolicy": true,
+      "@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption": true,
+      "@aws-cdk/aws-apigateway:disableCloudWatchRole": true,
+      "@aws-cdk/core:enablePartitionLiterals": true,
+      "@aws-cdk/aws-events:eventsTargetQueueSameAccount": true,
+      "@aws-cdk/aws-iam:standardizedServicePrincipals": true,
+      "@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker": true,
+      "@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName": true,
+      "@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy": true,
+      "@aws-cdk/aws-route53-patters:useCertificate": true,
+      "@aws-cdk/customresources:installLatestAwsSdkDefault": false,
+      "@aws-cdk/aws-rds:databaseProxyUniqueResourceName": true,
+      "@aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup": true,
+      "@aws-cdk/aws-apigateway:authorizerChangeDeploymentLogicalId": true,
+      "@aws-cdk/aws-ec2:launchTemplateDefaultUserData": true,
+      "@aws-cdk/aws-secretsmanager:useAttachedSecretResourcePolicyForSecretTargetAttachments": true,
+      "@aws-cdk/aws-redshift:columnId": true,
+      "@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2": true,
+      "@aws-cdk/aws-ec2:restrictDefaultSecurityGroup": true,
+      "@aws-cdk/aws-apigateway:requestValidatorUniqueId": true,
+      "@aws-cdk/aws-kms:aliasNameRef": true,
+      "@aws-cdk/aws-autoscaling:generateLaunchTemplateInsteadOfLaunchConfig": true,
+      "@aws-cdk/core:includePrefixInUniqueNameGeneration": true,
+      "@aws-cdk/aws-efs:denyAnonymousAccess": true,
+      "@aws-cdk/aws-opensearchservice:enableOpensearchMultiAzWithStandby": true,
+      "@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion": true,
+      "@aws-cdk/aws-efs:mountTargetOrderInsensitiveLogicalId": true,
+      "@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters": true,
+      "@aws-cdk/aws-appsync:useArnForSourceApiAssociationIdentifier": true,
+      "@aws-cdk/aws-rds:preventRenderingDeprecatedCredentials": true,
+      "@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true,
+      "@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction": true
+    }
+  }
+  

cdk_factory-0.0.1/examples/website/static_website/devops/commands/cdk_synth.sh

@@ -0,0 +1,40 @@
+echo building for branch: ${GIT_BRANCH_NAME}
+python --version
+            
+if [ -n "$PYTHON_312_VERSION" ]; then echo "Switching to Python version ${PYTHON_312_VERSION} - using environment var for version"; pyenv global "${PYTHON_312_VERSION}"; fi
+
+
+python --version
+echo printing environment vars
+env
+echo Extracting stack name from CODEBUILD_INITIATOR
+echo $CODEBUILD_INITIATOR
+# Extract the second part of CODEBUILD_INITIATOR (stack name)
+STACK_NAME=$(echo $CODEBUILD_INITIATOR | cut -d'/' -f2)
+echo Stack name is $STACK_NAME
+echo $(pwd) 
+export WORKING_DIRECTORY=$(pwd)
+echo $WORKING_DIRECTORY
+# install the main cdk-factory (we'll remove this later - once we publish the package)
+pip install -r ./src/requirements.txt
+pip install -e .
+ # install our example (this will be the main project)
+pip install -e ./examples/website/static_website
+
+# change to our samples project
+cd ./examples/website/static_website/devops
+echo $(pwd) 
+echo Installing requirements 
+# install requirement
+pip install -r requirements.txt 
+npx cdk synth {verbose} $STACK_NAME
+
+echo CDK Synth Complete
+echo $(pwd) 
+echo Listing Files in the sub project folder
+ls -la
+echo switch back to main path
+cd $WORKING_DIRECTORY
+echo $(pwd) 
+ls -la
+echo CDK Synth Complete