api-data

Linter and precommit install

UV

UV is a tool that aims to replace pip and pip-tools for managing Python dependencies. It uses roughly the same API as pip-tools, but it is way faster since it is written in Rust. Moreover, it is able to install different versions of python.

• Install the latest version :

  curl -LsSf https://astral.sh/uv/install.sh | sh

• Restart your shell

Python virtual environment, dependencies and git hooks (running before commit and push commands)

make install

Troubleshooting

• If make install fails due to pre-commit not found, please run once more make install.

Required : Install ggshield on your local machine if you don't already have it

Installation and usage of ggshield is documented in this Notion page

• Linux:

curl -1sLf 'https://dl.cloudsmith.io/public/gitguardian/ggshield/setup.deb.sh' | sudo -E bash

• MacOs:

brew install ggshield

Then authenticate to ggshield:

ggshield auth login

Formatting and static analysis

Checking formatting and static analysis with ruff

To check code formatting and static analysis:

make ruff-check

You can also integrate it to your IDE to reformat your code each time you save a file.

Format code and apply auto-fixes with ruff

To format code, run static analysis and to apply auto-fixes:

make ruff-fix

To run check micro service README

• Recommendation documentation

• Compliance documentation