Add first-class support for vscode development.

Author: igorborgest

.github/workflows/static-checking.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Setup Environment
-        run: ./requirements.sh
+        run: ./setup.sh
       - name: CloudFormation Lint - Base
         run: cfn-lint -t cloudformation/base.yaml
       - name: CloudFormation Lint - Databases

CONTRIBUTING.md

@@ -92,7 +92,7 @@ You can choose from three different environments to test your fixes/changes, bas
 
 * Then run the command bellow to install all dependencies:
 
-``./requirements.sh``
+``./setup.sh``
 
 * Run the validation script:
 
@@ -119,7 +119,7 @@ You can choose from three different environments to test your fixes/changes, bas
 
 * Then run the command bellow to install all dependencies:
 
-``./requirements.sh``
+``./setup.sh``
 
 * Go to the ``cloudformation`` directory
 
@@ -158,7 +158,7 @@ You can choose from three different environments to test your fixes/changes, bas
 
 * Then run the command bellow to install all dependencies:
 
-``./requirements.sh``
+``./setup.sh``
 
 * Go to the ``cloudformation`` directory
 

setup-vscode.sh

@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+set -e
+
+./setup.sh
+
+code --install-extension DavidAnson.vscode-markdownlint
+code --install-extension VisualStudioExptTeam.vscodeintellicode
+code --install-extension be5invis.toml
+code --install-extension donjayamanne.githistory
+code --install-extension ms-azuretools.vscode-docker
+code --install-extension ms-python.python
+code --install-extension ms-python.vscode-pylance
+code --install-extension redhat.vscode-yaml
+code --install-extension twixes.pypi-assistant
+code --install-extension aws-scripting-guy.cform
+
+python_path=$(which python)
+
+vscode_settings='{
+  "explorer.autoReveal": false,
+  "files.autoSave": "onFocusChange",
+  "files.exclude": {
+    "**/*.egg-info": true,
+    "**/.mypy_cache/": true,
+    "**/.pytest_cache/": true,
+    "**/__pycache__/": true
+  },
+  "outline.showArrays": false,
+  "outline.showConstants": false,
+  "outline.showFields": false,
+  "outline.showKeys": false,
+  "outline.showNull": false,
+  "outline.showStrings": false,
+  "outline.showTypeParameters": false,
+  "outline.showVariables": false,
+  "python.analysis.extraPaths": [
+  ],
+  "python.analysis.memory.keepLibraryAst": true,
+  "python.formatting.blackArgs": ["--line-length 120", "--target-version py36"],
+  "python.formatting.provider": "black",
+  "python.languageServer": "Pylance",
+  "python.linting.enabled": true,
+  "python.linting.flake8Args": ["--max-line-length 120"],
+  "python.linting.flake8Enabled": true,
+  "python.linting.mypyCategorySeverity.error": "Hint",
+  "python.linting.mypyCategorySeverity.note": "Hint",
+  "python.linting.mypyEnabled": true,
+  "python.linting.pylintEnabled": false,
+  "python.pythonPath": "'$python_path'",
+  "python.terminal.activateEnvironment": true,
+  "workbench.editor.labelFormat": "default",
+  "workbench.tree.indent": 16,
+  "yaml.customTags": [
+    "!Equals sequence",
+    "!FindInMap sequence",
+    "!GetAtt",
+    "!GetAZs",
+    "!ImportValue",
+    "!Join sequence",
+    "!Ref",
+    "!Select sequence",
+    "!Split sequence",
+    "!Sub"
+  ]
+}
+'
+
+rm -rf .vscode
+mkdir .vscode
+echo "$vscode_settings" > .vscode/settings.json

setup.py

@@ -1,9 +1,10 @@
 import os
 from io import open
 from setuptools import setup
+from typing import Dict
 
 here = os.path.abspath(os.path.dirname(__file__))
-about = {}
+about: Dict[str, str] = {}
 path = os.path.join(here, "awswrangler", "__metadata__.py")
 with open(file=path, mode="r", encoding="utf-8") as f:
     exec(f.read(), about)