Draft: RDK v1.0 refactor

.gitignore

@@ -1,8 +1,159 @@
-# Created by https://www.gitignore.io/api/python
-.gitignore
-### Python ###
+###############################################################################
+# .gitignore
+###############################################################################
+
+# Configure git to ignore things
+
+# Documentation:
+#   https://git-scm.com/docs/gitignore
+
+# Useful Templates
+#   https://github.com/github/gitignore
+
+# -----------------------------------------------------------------------------
+# BACKUPS
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/Backup.gitignore
+
+*.bak
+*.gho
+*.ori
+*.orig
+*.tmp
+
+# -----------------------------------------------------------------------------
+# MACOS
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
+
+# 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
+
+# -----------------------------------------------------------------------------
+# LINUX
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/Linux.gitignore
+
+*~
+
+# 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*
+
+# -----------------------------------------------------------------------------
+# WINDOWS
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/Windows.gitignore
+
+# 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
+
+# -----------------------------------------------------------------------------
+# VIM
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/Vim.gitignore
+
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+# -----------------------------------------------------------------------------
+# VSCODE
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Global/VisualStudioCode.gitignore
+
+.vscode
+# !.vscode/settings.json
+# !.vscode/tasks.json
+# !.vscode/launch.json
+# !.vscode/extensions.json
+*.code-workspace
+
+# -----------------------------------------------------------------------------
+# PYTHON SPECIFIC
+# -----------------------------------------------------------------------------
+
+# https://github.com/github/gitignore/blob/master/Python.gitignore
+
 # Byte-compiled / optimized / DLL files
-rdk/__pycache__/
+__pycache__/
 *.py[cod]
 *$py.class
 
@@ -23,9 +174,12 @@ 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
@@ -40,19 +194,28 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
 .coverage
 .coverage.*
 .cache
-.pytest_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
@@ -64,16 +227,35 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
+# IPython
+profile_default/
+ipython_config.py
+
 # pyenv
-.python-version
+#   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
+**.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
 
-# celery beat schedule file
-celerybeat-schedule.*
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
@@ -86,9 +268,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
-
-# intellij project setting
-.idea
+myenv/
 
 # Spyder project settings
 .spyderproject
@@ -102,29 +282,94 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# static files generated from Django application using `collectstatic`
+media
+static
+
+# -----------------------------------------------------------------------------
+# TERRAFORM SPECIFIC
+# -----------------------------------------------------------------------------
+
+# Local .terraform directories
+**/.terraform/*
+**/terraform.d/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+
+# Exclude all .tfvars files, which are likely to contain sentitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+#
+terraform.tfvars
+*.auto.tfvars
 
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
 
-# End of https://www.gitignore.io/api/python
+# Include override files you do wish to add to version control using negated pattern
+#
+# !example_override.tf
 
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+*tfplan*
 
-.vscode/launch.json
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
 
-.vscode/settings.json
+# -----------------------------------------------------------------------------
+# APPLICATION SPECIFIC
+# -----------------------------------------------------------------------------
 
-myAutomationTest/
+# pipenv stuff
+reqlib-metadata/
 
-myAutomationTestWithManegedRule/
+# Test and lint reports
+.reports/
 
-myAutomationTestWithManPeridoc/
+# Tool output dir
+.rdk/
 
-myAutomationTestWithResouceType/
+# Sonar
+.sonar/
+.scannerwork/
 
-.vscode/sk.py
+# Terraform
+.terraform.d/
 
-CLOUD_TRAIL_ENCRYPTION_ENABLED/
+# Docs (generated)
+docs/reference/api/
+docs/reference/cli.md
+docs/CHANGELOG.md
 
-API_GW_NOT_EDGE_OPTIMISED/
+###############################################################################
 
-manageTest/
 
-football/
+# CDK
+**/cdk.out/
+cdk.out
+cdk.out/
+cdk.out/**

LICENSE

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
+      boilerplate notice, with the fields enclosed by brackets "[]"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.