Release/version 0.6.0

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+exclude = .venv *.json
+

.gitignore

@@ -2,7 +2,6 @@
 __pycache__/
 *.py[cod]
 *$py.class
-
 # C extensions
 *.so
 
@@ -127,6 +126,9 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+commit_message.txt
+./commit_message.txt
+
 
 # Spyder project settings
 .spyderproject
@@ -158,3 +160,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+.DS_Store

.pylintrc

@@ -0,0 +1,41 @@
+[FORMAT]
+
+# Set the maximum line length to 100 characters
+max-line-length=120
+
+[MESSAGES CONTROL]
+disable=
+    C0103,
+    C0116,
+    ; C0114,
+    C0115,
+    ; C0411,
+    R0801,
+    R0902,
+    R0903,
+    R0913,
+    R0914,
+    R1710,
+    W0102,
+    W0613,
+    W0621,
+    W0622,
+    W0718,
+    W3101
+# C0103: doesn't conform to snake_case naming style (invalid-name)<- missing just helper functions
+# C0116: Missing function or method docstring
+# C0114: Missing module docstring (missing-module-docstring)
+# C0115: Missing class docstring
+# C0411: Wrong import order %s
+# R0801: Similar lines in %s files
+# R0902: Too many instance attributes
+# R0903: Too few public methods
+# R0913: Too many arguments
+# R0914: Too many local variables
+# R1710: Either all return statements in a function should return an expression, or none of them should.
+# W0102: Dangerous default value %s as argument
+# W0613: Unused argument
+# W0621: Redefining name %r from outer scope (line %s)
+# W0622: Redefining built-in 'foo' (redefined-builtin)
+# W0718: Catching too general exception Exception
+# W3101: Missing timmeout can expose you to a DOS attack

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.formatting.provider": "none"
+}

CONTRIBUTING.md

@@ -1,10 +1,82 @@
-Contributing guidelines
-=======================
+# Contributing guidelines
 
-### Git workflow
+## Git workflow
 
-* Use git-flow - create a feature branch from `develop`, e.g. `feature/new-feature`
+* Use git-flow - create a feature branch from `develop`, e.g. `feat/new-feature`
 * Pull requests must contain a succinct, clear summary of what the user need is driving this feature change
 * Ensure your branch contains logical atomic commits before sending a pull request
 * You may rebase your branch after feedback if it's to include relevant updates from the develop branch. It is preferable to rebase here then a merge commit as a clean and straight history on develop with discrete merge commits for features is preferred
 * To find out more about contributing click [here](https://contributing.md/)
+
+## Branching
+* Branches should be named in the following format:
+  ```textbox
+  <type>/<description>
+  ```
+  where `type` is one of the following:
+    ```textbox
+    * fix: for a bug fix
+    * feat: for a new feature
+    * docs: for documentation changes
+    * style: for changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+    * refactor: for refactoring production code
+    * test: for adding tests
+    * chore: for updating build tasks, package manager configs, etc
+    * build: for changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+    ```
+  and `description` is a short description of the feature or fix being made
+  * e.g. `feat/new-feature` or `fix/bug-fix`
+* Branches should be created from the `develop` branch
+* Branches should be merged back into the `develop` branch
+
+## Commit messages
+
+Please use the following format for commit messages:
+
+```textbox
+* fix: for a bug fix
+* feat: for a new feature
+* docs: for documentation changes
+* style: for changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+* refactor: for refactoring production code
+* test: for adding tests
+* chore: for updating build tasks, package manager configs, etc
+* build: for changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+```
+
+## Pull requests
+
+* Pull requests should be made to the `develop` branch
+* Pull requests should be made from a feature branch, not `develop`
+* Pull requests should be made with a succinct, clear summary of what the user need is driving this feature change
+* An automated template will be provided to help with this process, please fill it out as best you can
+
+## Release branches and Tagging
+
+* Once a single or set of changes has been made that can be released, we create a release branch off develop
+  * Releases should be as small as possible so that it is easier to fix issues and rollback code in production environment without losing many features at once
+  * Release branches should be of the following structure:
+
+    ```sh
+    release/0.1.0
+    ```
+
+  * The release name should abide by [semantic versioning (semver)](https://semver.org/)
+* Once release branch has been created, a pull request should be made against the `main` branch
+* Once approved, the release branch can be merged locally :warning: **WARNING - Do not push to remote** :warning:
+* Tag the release and push to remote - [see tagging](#tagging)
+
+## Tagging
+
+* Tag latest commit on branch, this should be the local merge commit
+  * Check latest local commit, run: `git show HEAD`
+  * Create tag, run: `tag -s <tag> -m <message>`
+    * where `tag` is the semver value (should be taken from the release branch name) and `<message>` is a general, short and concise message of the change
+* Push release merge and tag to remote, run: `git push --follow-tags`
+* Once pushed, go to the Github releases page for the repository in question, which can be found by clicking on the <> Code tab and clicking on Releases on the right hand side:
+  * Select Tags
+  * Click on the v0.1.0 tag that you just created
+  * Choose Create release from tag
+  * Copy the release name and make human-friendly (capitalise, remove /) to create a release title (e.g. release/0.1.0 -> Release 0.1.0)
+  * Add relevant release notes, this can be expanded from initial message created against the tag. Advised to use bullet points to list out changes
+  * Hit Publish release

Makefile

@@ -0,0 +1,105 @@
+.ONESHELL:
+
+.DEFAULT_GOAL := run
+
+PYTHON = ./.venv/bin/python3
+PIP = ./.venv/bin/pip
+
+
+.PHONY: help auth clean dbclean mongostart mongostop run setup swag test test-setup
+
+help:
+	@echo "make help - display this help"
+	@echo "make auth - run auth api application"
+	@echo "make build - create and activate virtual environment"
+	@echo "make clean - remove all generated files"
+	@echo "make dbclean - clear the application database"
+	@echo "make mongostart - start local mongodb instance"
+	@echo "make mongostop - stop local mongodb instance"
+	@echo "make run - run the application"
+	@echo "make swag - open swagger documentation"
+	@echo "make setup - setup the application database"
+	@echo "make test - run tests and coverage report"
+	@echo "make test-setup - setup the test database"
+	@echo "make helptools - display help for tools"
+
+auth:
+	$(PYTHON) ../tdse-accessForce-auth-stub/app.py
+
+build: requirements.txt
+	python3 -m venv .venv
+	$(PIP) install -r requirements.txt
+	. ./.venv/bin/activate
+
+clean:
+	@echo "Cleaning up..."
+	@find . -name "__pycache__" -type d -exec rm -rf {} +
+	@find . -name ".pytest_cache" -exec rm -rf {} +
+	@find . -name ".venv" -exec rm -rf {} +	
+
+dbclean:
+	@echo "Cleaning up database..."
+	cd ./scripts/; \
+	make dbclean
+	@echo "Database cleared."
+
+mongostart:
+	@echo "Starting MongoDB..."
+	brew services start [email protected]
+
+mongostop:
+	@echo "Stopping MongoDB..."
+	brew services stop [email protected]
+
+run: build
+	$(PYTHON) app.py
+
+setup:
+	@echo "Setting up application database..."
+	cd ./scripts/; \
+	make dbclean; \
+	make bids; \
+	make questions
+	@echo "Database setup complete."
+
+swag:
+	open http://localhost:8080/api/docs/#/
+
+test: 
+	-coverage run -m pytest -vv
+	@echo "TEST COVERAGE REPORT"
+	coverage report -m --omit="app.py,tests/*,dbconfig/*"
+
+test-setup:
+	@echo "Setting up test database..."
+	export TEST_ENVIRONMENT=true; \
+	cd ./scripts/; \
+	make dbclean; \
+	make bids; \
+	make questions; \
+	export TEST_ENVIRONMENT=
+	@echo "Test database setup complete."
+
+.PHONY: helptools authplay branch check commit format lint
+
+helptools:
+	make -f tools.mk help
+
+authplay:
+	cd ./scripts/; \
+	make authplay
+
+branch:
+	make -f tools.mk branch
+
+check:
+	make -f tools.mk check
+
+commit:
+	make -f tools.mk commit
+
+format: 
+	make -f tools.mk format
+
+lint:
+	make -f tools.mk lint