2020-12-21
Build System / Dependencies
* **DOCKERFILE:** bootstrap container, adjust workflow (9a029bfd)
* **SETUP:** ensure the config.yml file is included in built wheels (307af0e2)
Documentation Changes
* **README:**
* add a note on how to configure the host machine (29cb9190)
* add external link to read the docs disto (9c8543ad)
* remove unneeded markdown file (3fd7559d)
* update documentation to reflect current state of the project (37b763fb)
* **SPHINX:**
* switch m2r2 for markdown generation (f62cbf91)
* create toc tree, and add support for click cli commands (34762660)
* **READTHEDOCS:** add all dependencies to the read the docs configuration (ee362bae)
* **DOCSTRINGS:**
* bring all docstrings up to the sphinx convention (51b571ef)
* clean up support docstrings to suggest their real purpose (c19af2d1)
* **CLI:** add docstrings for click documentation (474f59f8)
New Features
* **CONFIG:**
* ensure project name env variable is set on startup (1980f856)
* allow configuration yaml location to be customized (14c157f9)
* remove unnecessary quotes (2de64702)
* **SCRIPTS.HOSTMACHINE:** include small bash script to setup the hostmachine (09cab9c5)
* **CLI:**
* cli uses new internal command fn (bc3b7139)
* use pure python function for bash setup (641fc1b1)
* implement setup command, support command batching (5a036506)
* rename the setup command to setup-bash, make it container only (8fc514dc)
* **SUPPORT.INTERNAL_COMMANDS:** implement execute internal command (cab9ca61)
* **SUPPORT.COMMANDS:**
* create a pure python function to setup the bash environment (9626e217)
* return exit_code 0 when a container is required to run the command (4c64580b)
* allow the yaml configuration to specify if the command is container only (76c7789d)
* support the command clause as both a string or list (e402576c)
* extract class from cli command invocation, and create yaml configuration (00dd69ba)
* **BASH:** bundle bash scripts, add bash completion, tidy external scripts (210fa328)
* **SUPPORT.PATHS:** allow path manager class to detect if it's in a supported container (8fc4805a)
* **CLI.REINSTALL-REQUIREMENTS:** implement the reinstall-requirements command (0b5bcf49)
* **CLI.COVERAGE:** implement code coverage command (bd7c5ee0)
* **CLI.TEST:** implement the unittests command (ed1034e8)
* **CLI.FMT:** implement code formatters command (94d00149)
* **CLI.BUILD-WHEEL:** implement the build-wheel command (4e123254)
* **SECURITY:** use safe_load for yaml operations to make bandit happy (85be2f81)
* **CLI.LINT:** implement linter tests (ff8e417b)
* **CLI.SECTEST:** implement the security tests (75b37680)
* **SUPPORT.PROCESSES:** support batched commands (f530c625)
* **CLI.BUILD-DOCS:** implement build-docs command (35f9fbba)
Bug Fixes
* **SCRIPTS.DEV:** catch by the shellcheck linter (0764670c)
* **SUPPORT.PATHS:** use proper path for container marker (765c829d)
* **CLI:** rewrite some docstrings to provide better descriptions from click (071c164e)
* **SHIM:** fix the cli shim to point to the renamed cli module (a5936f95)
* **CLI.INIT:** remove useless conditional (d1a5fc70)
Other Changes
* **CLI.SETUP-BASH:** partial implementation of setup-bash (88f00120)
Refactors
* **SUPPORT.INTERNAL_COMMANDS:**
* convert to class (9fd317e1)
* extract module from support.external_commands (7c4a79fb)
* **SUPPORT.PROCESSES:** move method (93f1aa09)
* **CLI:**
* move fn execute_external_command to support.external_commands (22736d47)
* refactor test patches into single patchbay file (73336d04)
* complete extract class by referring execution logic to extern commands class (204b1e71)
* rename utilities module and relocate support tests (675455c6)
* **IMPORTS:**
* prefer relative import (f30a6ec8)
* seperate local and third party imports (2c774578)
* **PATCHBAY:** reorder/rename some patch points (dbb81678)
* **SUPPORT.EXTERNAL_COMMANDS:** rename the commands class to reflect it's intended purpose (83ad28d5)
* **CONFIG:**
* extract additional config settings, rename to make use case obvious (d2b172ac)
* centralize the yaml configuration under the config folder (1a8674d8)
* **CONFIG.YML:** move config.yml into the common configuration folder (320adf86)
* **SUPPORT.CONFIGURATION:** extract class from support.commands (2e411e84)
* **SUPPORT.CONTAINER:** extract class from support.commands (9babccc3)
* **TESTS:** consolidate patch locations into single module (33208211)
* **ASSERTIONS:** use the assertions provided by unittest.testcase (908c7f58)
* **SUPPORT.YAML_KEYS:** remove hardcoded yaml keys and make them references (e342b27d)
* **SUPPORT.COMMANDS:** extract methods (0a1dc213)
Code Style Changes
* **YAPF:** change yapf dedent rule setting (6c894532)
* **WHITESPACE:** add consistent new line after all docstrings (2a53dc9d)
Tests
* **CLI:**
* add extra assertion for setup_bash (8576ce50)
* fix brittle tests, allow to run outside the container (c852e9f5)
* **SUPPORT.COMMANDS:** invert container state to ensure complete coverage (e8a0c66f)
* **CLI.LINT:** add tests for the lint command (7a3e58c1)
* **SUPPORT.UTILITIES:** add coverage for the cli utilities (8f473619)
* **CLI.SECTEST:** add tests for the security tests (a48fa90f)