aimingmed-ai/app/proto-docs/docs/code_quality.md

Formatting

Black is recommended to format the Python files. It is a highly opinionated formatter that follows PEP8.

Typical Workflow

1. Add black python library as dev dependency in the virtual environment. Pin down the version if necessary.

   === "Poetry"

    ```bash
    poetry add -G dev black
    ```
   

   === "Conda"

    ```bash
    conda install black
    ```
   

2. Install Black vscode extension as specified in Computer Setup

3. Enable format on save in your editor

Additional settings

Black can be customized through pyproject.toml

Black settings are explained in here.

Linting

Ruff is recommended to lint the Python files.

Typical Workflow

1. Add ruff python library as dev dependency in the virtual environment. Pin down the version if necessary.

   === "Poetry"

    ```bash
    poetry add -G dev ruff
    ```
   

   === "Conda"

    ```bash
    conda install ruff
    ```
   

2. Install Ruff vscode extension as specified in Computer Setup

Additional setting

Ruff can be customized through pyproject.toml

Ruff settings are explained in here.

Type checking

Pyright is recommended to type check all python files in the project.

Typical Worklow

1. Add pyright python library as dev dependency in the virtual environment. Pin down the version if necessary.

   === "Poetry"

    ```bash
    poetry add -G dev pyright
    ```
   

   === "Conda"

    ```bash
    conda install pyright
    ```
   

2. Install Python vscode extension as specified in Computer Setup

Additional setting

Pyright can be customized through pyproject.toml

Pyright settings are explained in here