runbooks 0.2.5__py3-none-any.whl → 0.6.1__py3-none-any.whl

runbooks/inventory/.gitignore

@@ -0,0 +1,354 @@
+# Exclude *.pyc files
+*.pyc
+
+# Ootput files for tool tests
+test_output_*.txt
+SmallestCFNEver.yaml
+*.png
+
+# Created by https://www.gitignore.io/api/osx,node,linux,python,windows,visualstudiocode
+# Edit at https://www.gitignore.io/?templates=osx,node,linux,python,windows,visualstudiocode
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test12 coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# 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/
+pip-wheel-metadata/
+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 test12 / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.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/
+
+### VisualStudioCode ###
+.vscode/*
+# !.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/osx,node,linux,python,windows,visualstudiocode
+
+## Custom
+
+# Loyalty transpiled JS
+src/backend/loyalty/src/**/*.js
+
+# local env files
+.env.local
+.env.*.local
+
+# Custom
+TEMPORARY/
+codebuild_build.sh
+Dockerfile
+packaged.yaml
+*.aws-sam/
+artifacts/
+datasources.json
+test_report/
+src/frontend/graphql
+
+# Cypress videos and screenshots
+src/e2e-tests/ui/**/cypress/videos
+src/e2e-tests/ui/**/cypress/screenshots
+
+
+# Created by https://www.gitignore.io/api/node,linux,macos,python,windows,visualstudiocode
+# Edit at https://www.gitignore.io/?templates=node,linux,macos,python,windows,visualstudiocode
+
+#amplify
+amplify/\#current-cloud-backend
+amplify/.config/local-*
+amplify/backend/amplify-meta.json
+amplify/backend/awscloudformation
+aws-exports.js
+awsconfiguration.json
+amplifyconfiguration.json
+amplify-gradle-config.json
+amplifyxc.config
+
+# Code packaging working directory
+src/.package
+#src/securityhub_enabler.zip
+
+.idea/
+/venv3.7.9/
+.idea/*
+
+my_venv/
+/stackoverflow_test/

runbooks/inventory/ArgumentsClass.py

@@ -0,0 +1,261 @@
+# Write Python3 code here
+"""
+How to use:
+        from ArgumentsClass import CommonArguments
+        parser = CommonArguments()
+        parser.extendedargs()
+        parser.my_parser.add_argument(...
+        < ... >
+        < Add more arguments as you would like >
+        < ... >
+        args = parser.my_parser.parse_args()
+
+        pProfile = args.Profile
+        pRegionList = args.Regions
+        verbose = args.loglevel
+
+"""
+
+__version__ = "2024.09.24"
+
+import os
+
+
+class CommonArguments:
+    """
+    Class is created on the argparse class, and extends it for my purposes.
+    """
+
+    def __init__(self):
+        import argparse
+
+        self.my_parser = argparse.ArgumentParser(
+            description="Accept common arguments to the Inventory Scripts", allow_abbrev=True, prefix_chars="-+"
+        )
+
+    def version(self, script_version):
+        self.my_parser.add_argument(
+            "--version", help="Version #", action="version", version=f"Version: {script_version}"
+        )
+
+    def rootOnly(self):
+        self.my_parser.add_argument(
+            "--rootonly",
+            dest="RootOnly",
+            action="store_true",  # Defaults to False, so the script would continue to run
+            help="Only run this code for the root account, not the children",
+        )
+
+    def roletouse(self):
+        self.my_parser.add_argument(
+            "--access_rolename",
+            dest="AccessRole",
+            default=None,
+            metavar="role to use for access to child accounts",
+            help="This parameter specifies the single role that will allow this script to have access to the children accounts.",
+        )
+
+    def rolestouse(self):
+        self.my_parser.add_argument(
+            "--access_rolename",
+            dest="AccessRoles",
+            nargs="*",
+            default=None,
+            metavar="roles to use for access to child accounts",
+            help="This parameter specifies the list of roles that will allow this script to have access to the children accounts.",
+        )
+
+    def deletion(self):
+        # self.my_parser.add_argument(
+        # 	"+forreal",
+        # 	help="By default, we report results without changing anything. If you want to remediate or change your environment - include this parameter",
+        # 	action="store_false",
+        # 	dest="DryRun")              # Default to Dry Run (no changes)
+        self.my_parser.add_argument(
+            "+force", help="To force a change - despite indications to the contrary", action="store_true", dest="Force"
+        )  # Default to Dry Run (no changes)
+
+    def confirm(self):
+        self.my_parser.add_argument(
+            "+confirm", help="To skip confirmation of a change", action="store_true", dest="Confirm"
+        )  # Default to Dry Run (no changes)
+
+    def fix(self):
+        self.my_parser.add_argument(
+            "+fix", help="To intrusively fix something in your accounts", action="store_true", dest="Fix"
+        )
+
+    def verbosity(self):
+        import logging
+
+        self.my_parser.add_argument(
+            "-v",
+            help="Be verbose (Error Statements)",
+            action="store_const",
+            dest="loglevel",
+            const=logging.ERROR,  # args.loglevel = 40
+            default=logging.CRITICAL,
+        )  # args.loglevel = 50
+        self.my_parser.add_argument(
+            "-vv",
+            "--verbose",
+            help="Be MORE verbose (Warning statements)",
+            action="store_const",
+            dest="loglevel",
+            const=logging.WARNING,  # args.loglevel = 30
+            default=logging.CRITICAL,
+        )  # args.loglevel = 50
+        self.my_parser.add_argument(
+            "-vvv",
+            help="Print INFO statements",
+            action="store_const",
+            dest="loglevel",
+            const=logging.INFO,  # args.loglevel = 20
+            default=logging.CRITICAL,
+        )  # args.loglevel = 50
+        self.my_parser.add_argument(
+            "-d",
+            "--debug",
+            help="Print debugging statements",
+            action="store_const",
+            dest="loglevel",
+            const=logging.DEBUG,  # args.loglevel = 10
+            default=logging.CRITICAL,
+        )  # args.loglevel = 50
+
+    def extendedargs(self):
+        self.my_parser.add_argument(
+            "-k",
+            "-ka",
+            "--skip",
+            "--skipaccount",
+            "--skipaccounts",
+            dest="SkipAccounts",
+            nargs="*",
+            metavar="Accounts to leave alone",
+            default=None,
+            help="These are the account numbers you don't want to screw with. Likely the core accounts.",
+        )
+        self.my_parser.add_argument(
+            "-kp",
+            "--skipprofile",
+            "--skipprofiles",
+            dest="SkipProfiles",
+            nargs="*",
+            metavar="Profile names",
+            default=None,
+            help="These are the profiles you don't want to examine. You can specify 'skipplus' to skip over all profiles using a plus in them.",
+        )
+        self.my_parser.add_argument(
+            "-a",
+            "--account",
+            dest="Accounts",
+            default=None,
+            nargs="*",
+            metavar="Account",
+            help="Just the accounts you want to check",
+        )
+
+    def timing(self):
+        self.my_parser.add_argument(
+            "--timing",
+            "--time",
+            dest="Time",
+            action="store_true",
+            help="Use this parameter to add a timing for the scripts",
+        )
+
+    def fragment(self):
+        self.my_parser.add_argument(
+            "-f",
+            "--fragment",
+            dest="Fragments",
+            nargs="*",
+            metavar="string fragment",
+            default=["all"],
+            help="List of fragments of the string(s) you want to check for.",
+        )
+        self.my_parser.add_argument(
+            "-e",
+            "--exact",
+            dest="Exact",
+            action="store_true",
+            help="Use this flag to make sure that ONLY the string you specified will be identified",
+        )
+
+    def singleprofile(self):
+        self.my_parser.add_argument(
+            "-p",
+            "--profile",
+            dest="Profile",
+            metavar="Profile",
+            default=None,  # Default to boto3 defaults
+            help="Which *single* profile do you want to run against?",
+        )
+
+    def multiprofile(self):
+        self.my_parser.add_argument(
+            "-p",
+            "-ps",
+            "--profiles",
+            dest="Profiles",
+            nargs="*",
+            metavar="Profiles",
+            default=None,  # Defaults to default profile, but can support multiple profiles
+            help="Which profiles do you want to run against?",
+        )
+
+    def multiregion(self):
+        self.my_parser.add_argument(
+            "-rs",
+            "--regions",
+            "-r",
+            nargs="*",
+            dest="Regions",
+            metavar="region name string",
+            # default=["us-east-1"],
+            default=[os.getenv("AWS_DEFAULT_REGION", "us-east-1")],
+            help="String fragment of the region(s) you want to check for resources. You can supply multiple fragments.\n"
+            "Use 'all' for everything you've opted into, and 'global' for everything, regardless of opted-in status",
+        )
+
+    def multiregion_nodefault(self):
+        self.my_parser.add_argument(
+            "-r",
+            "-rs",
+            "--regions",
+            nargs="*",
+            dest="Regions",
+            metavar="region name string",
+            default=None,
+            help="String fragment of the region(s) you want to check for resources. You can supply multiple fragments.",
+        )
+
+    def singleregion(self):
+        self.my_parser.add_argument(
+            "-r",
+            "--region",
+            dest="Region",
+            metavar="region name string",
+            default="us-east-1",
+            help="Name of the *single* region you want to check for resources.",
+        )
+
+    def singleregion_nodefault(self):
+        self.my_parser.add_argument(
+            "-r",
+            "--region",
+            dest="Region",
+            metavar="region name string",
+            default=None,
+            help="Name of the *single* region you want to check for resources.",
+        )
+
+    def save_to_file(self):
+        self.my_parser.add_argument(
+            "--filename",
+            dest="Filename",
+            metavar="filename",
+            default=None,
+            help="Name of the filename you want to save results to.",
+        )