README.md

Algorithm_in_Python

Get started:

Run these command line in terminal at the root directory

1. pip install poetry
2. poetry config virtualenvs.in-project true
3. poetry install --with dev
4. poetry run pre-commit install
5. poetry run pre-commit autoupdate

Intro:

To make both task itself and its test workable, I put the following code to every file's head to avoid ImportError

import os
import sys

sys.path.append(os.path.abspath("."))

linter check

• Mac OS user
  • run chmod +x ./linter_check.sh at the root directory to solve permission denied error
  • run ./linter_check.sh at root directory, it will execute both mypy and pylint
• Windows user
  • run ./linter_check.ps1

unit test

• Mac OS user
  • run chmod +x ./tests.sh at the root directory to solve permission denied error
  • run ./tests.sh at root directory to run all the unit tests
• Windows user
  • run ./tests.ps1