gurashish1singh / initial_setup

This repo will act as a base for future repos to be created.

Placeholder Project Name

Initial setup

The bash script setup.sh is an executable which needs to be run to setup the local environment. Devs should run

chmod +x setup.sh

(Powershell may have different syntax to set executable permissions) before running

bash setup.sh

The pyproject.toml file contains project dependencies and can be updated to add more dependencies at any stage of the project by running poetry add <packagename>. Minimum Python version supported is 3.9.

The .pre-commit-config.yaml contains linters that run before commiting.

initial_setup's Issues

Update conditional check to install poetry for CMD

if [[ $(command -v poetry) ]]; then

The above conditional to check if poetry is installed to the user's path in the shell script, setup.sh only works for GitBash and Unix-like terminals. This check does not work on CMD.

AC:

• Update the conditional to check if poetry is already installed to be successful on CMD

Update conditional check to install poetry for PowerShell

if [[ $(command -v poetry) ]]; then

The above conditional to check if poetry is installed to the user's path in the shell script, setup.sh only works for GitBash and Unix-like terminals. This check does not work on PowerShell.

Furthermore, poetry installation fails due to a ModuleNotFoundError:

AC:

• Update the conditional to check if poetry is already installed to be successful on PowerShell
• Fix the ModuleNotFoundError (full error stack attached)

poetry-installer-error-xodgg7gb.log

Add automated testing using tox

A boilerplate tox setup to run the test suite using pytest and coverage is needed.
This should also be hooked to pre-commit to run during the push stage.

The tox environment should:

• Install all test dependencies:
  • pytest
  • coverage
  • lizard: or should lizard be a separate linting hook to be run during each commit?
• Run test test suite and fail on coverage less than 90%

AC:

• tox is added to setup.sh to be installed as a dev dependency
• tox is setup to run tests using pytest and coverage
  • coverage less than 90% should cause the tests to fail
• A boilerplate test dir is added
  • logger tests?