Skip to content

build(server): new tooling & supporting docs#6

Merged
YiqinZhao merged 6 commits intocake-lab:mainfrom
FelixNgFender:main
Sep 9, 2024
Merged

build(server): new tooling & supporting docs#6
YiqinZhao merged 6 commits intocake-lab:mainfrom
FelixNgFender:main

Conversation

@FelixNgFender
Copy link
Contributor

@FelixNgFender FelixNgFender commented Sep 6, 2024

I upgraded our Python toolchain:

  • Replaced black, isort, and flake8 with ruff
  • Type checking with pyright and Pylance VSCode extension
  • All quality checks are checked before each commit with a pre-commit hook
  • Added docs to support the use of the new tools

I also refined the simple example displayed on the README.md of the server Python package.

Actions items left (added to backlog, will be in a follow-up PR):

  • Figure out how to embed Python examples/scripts in Markdown, e.g., pdoc's custom template
  • Enable strict type checking for pyright and Pylance and resolve all current errors
  • Enable type checking in the pre-commit hook

…ting

Replaced `black`, `isort`, `flake8` with `ruff`. Added a `pre-commit` hook for running checks before a commit, `pytest` (testing) and `pyright` (type checking)
Already included in `README.md`
Copy link
Member

@YiqinZhao YiqinZhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! I just added one comment.

Copy link
Member

@YiqinZhao YiqinZhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGM!

@YiqinZhao YiqinZhao merged commit 8efc164 into cake-lab:main Sep 9, 2024
@YiqinZhao YiqinZhao added WPI Projects created by WPI students. MQP Project related to WPI MQP projects. labels Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

MQP Project related to WPI MQP projects. WPI Projects created by WPI students.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants