Rename (#2)

.gitignore

@@ -1,5 +1,5 @@
 .coverage
-changedifferently.egg-info
 coverage.xml
 dist
 htmlcov
+stackdiff.egg-info

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
-    "changedifferently"
+    "epilog",
+    "stackdiff"
   ]
 }

MANIFEST.in

@@ -1 +1 @@
-include changedifferently/version/VERSION
+include stackdiff/version/VERSION

Pipfile

@@ -4,15 +4,21 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
+ansiscape = "~=1.0"
+boto3 = "~=1.18"
+differently = "==1.0.0a6"
+tabulate = "~=0.8"
 
 [dev-packages]
 black = "==21.9b0"
+boto3-stubs = {extras = ["cloudformation"], version = "*"}
 flake8 = "*"
 isort = "*"
 mypy = "*"
 pytest = "*"
 pytest-cov = "*"
 twine = "*"
+types-tabulate = "~=0.8"
 shellcheck-py = "*"
 yamllint = "*"
 

README.md

@@ -1,2 +1,3 @@
-# changedifferently
-Visualises the changes described by an Amazon Web Services CloudFormation change set
+# stackdiff
+
+Visualises the changes described by an Amazon Web Services CloudFormation stack change set

build.sh

@@ -10,7 +10,7 @@ else
   version="-1.-1.-1"
 fi
 
-echo "${version}" > changedifferently/version/VERSION
+echo "${version}" > stackdiff/version/VERSION
 rm -rf dist
 python setup.py bdist_wheel
 rm -rf build

lint.sh

@@ -18,5 +18,5 @@ else
 fi
 
 flake8 .
-mypy changedifferently
+mypy stackdiff
 mypy tests

pyproject.toml

@@ -6,6 +6,6 @@ profile = 'black'
 skip = '.venv'
 
 [tool.pytest.ini_options]
-addopts = '--cov=changedifferently --cov-branch --cov-report=html --cov-report=term-missing:skip-covered --cov-report=xml --no-cov-on-fail'
+addopts = '--cov=stackdiff --cov-branch --cov-report=html --cov-report=term-missing:skip-covered --cov-report=xml --no-cov-on-fail'
 log_cli = 1
 testpaths = 'tests'

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup  # pyright: reportMissingTypeStubs=false
 
-from changedifferently.version import get_version
+from stackdiff.version import get_version
 
 readme_path = Path(__file__).parent / "README.md"
 
@@ -36,21 +36,26 @@
     author="Cariad Eccleston",
     author_email="[email protected]",
     classifiers=classifiers,
-    description="Visualises the changes described by an Amazon Web Services CloudFormation change set",
+    description="Visualises the changes described by an Amazon Web Services CloudFormation stack change set",
+    entry_points={
+        "console_scripts": [
+            "stackdiff=stackdiff.__main__:cli_entry",
+        ],
+    },
     include_package_data=True,
     license="MIT",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    name="changedifferently",
+    name="stackdiff",
     packages=[
-        "changedifferently",
-        "changedifferently.version",
+        "stackdiff",
+        "stackdiff.version",
     ],
     package_data={
-        "changedifferently": ["py.typed"],
-        "changedifferently.version": ["py.typed"],
+        "stackdiff": ["py.typed"],
+        "stackdiff.version": ["py.typed"],
     },
     python_requires=">=3.8",
-    url="https://github.com/cariad/changedifferently",
+    url="https://github.com/cariad/stackdiff",
     version=version,
 )

stackdiff/__main__.py

@@ -0,0 +1,32 @@
+from argparse import ArgumentParser
+from sys import stdout
+
+from boto3.session import Session
+
+from stackdiff.stack_diff import StackDiff
+from stackdiff.version import get_version
+
+
+def cli_entry() -> None:
+    parser = ArgumentParser(
+        description="Visualises the changes described by an Amazon Web Services CloudFormation stack change set.",
+        epilog="Made with love by Cariad Eccleston: https://github.com/cariad/stackdiff",
+    )
+
+    parser.add_argument("--change", help="change set ARN, ID or name")
+    parser.add_argument("--stack", help="stack ARN, ID or name")
+    parser.add_argument("--version", action="store_true", help="print the version")
+
+    args = parser.parse_args()
+
+    if args.version:
+        print(get_version())
+        exit(0)
+
+    cs = StackDiff(change=args.change, session=Session(), stack=args.stack)
+    cs.render_differences(stdout)
+    cs.render_changes(stdout)
+
+
+if __name__ == "__main__":
+    cli_entry()