diff --git a/Makefile b/Makefile index 5cfa3a9d6..cf4192b26 100644 --- a/Makefile +++ b/Makefile @@ -801,7 +801,7 @@ images: # help: pydocstyle - Docstring style checker # help: pycodestyle - Simple PEP-8 checker # help: pre-commit - Run all configured pre-commit hooks -# help: ruff - Ruff linter + formatter +# help: ruff - Ruff linter + (eventually) formatter # help: ty - Ty type checker from astral # help: pyright - Static type-checking with Pyright # help: radon - Code complexity & maintainability metrics @@ -1064,8 +1064,9 @@ pre-commit: ## 🪄 Run pre-commit hooks fi @/bin/bash -c "source $(VENV_DIR)/bin/activate && pre-commit run --all-files --show-diff-on-failure" -ruff: ## ⚡ Ruff lint + format - @echo "⚡ ruff $(TARGET)..." && $(VENV_DIR)/bin/ruff check $(TARGET) && $(VENV_DIR)/bin/ruff format $(TARGET) +ruff: ## ⚡ Ruff lint + (eventually) format + @echo "⚡ ruff $(TARGET)..." && $(VENV_DIR)/bin/ruff check $(TARGET) + # && $(VENV_DIR)/bin/ruff format $(TARGET) # Separate ruff targets for different modes ruff-check: @@ -1074,6 +1075,7 @@ ruff-check: ruff-fix: @echo "⚡ ruff check --fix $(TARGET)..." && $(VENV_DIR)/bin/ruff check --fix $(TARGET) +# Nothing depends on this target yet, but kept for future and ad hoc use ruff-format: @echo "⚡ ruff format $(TARGET)..." && $(VENV_DIR)/bin/ruff format $(TARGET) diff --git a/docs/docs/best-practices/mcp-best-practices.md b/docs/docs/best-practices/mcp-best-practices.md index 84feba474..71f7378fb 100644 --- a/docs/docs/best-practices/mcp-best-practices.md +++ b/docs/docs/best-practices/mcp-best-practices.md @@ -1,6 +1,6 @@ # Best Practices -## Input and output santitization +## Input and output sanitization Ensure your inputs and outputs are sanitized. In Python, we recommend using Pydantic V2. @@ -44,7 +44,7 @@ Make targets are grouped by functionality. Use `make help` to see them all in yo | Target | Description | |----------------------|-------------| -| `make lint` | Run all linters (e.g., `ruff check`, `ruff format`). | +| `make lint` | Run all linters (e.g., `ruff check`, `black`, `isort`). | #### 🐳 CONTAINER BUILD & RUN @@ -69,7 +69,7 @@ Each repo must include a `Containerfile` (Podman-compatible, Docker-compatible) ### Containerfile Requirements: -- Must start from a secure base (e.g., latest Red Hat UBI9 minimal image `registry.access.redhat.com/ubi9-minimal:9.5-1741850109`) +- Must start from a secure base (e.g., latest Red Hat UBI10 minimal image `registry.access.redhat.com/ubi10-minimal:10.0-1755721767`) - Should use `uv` or `pdm` to install dependencies via `pyproject.toml` - Must run the server using the same entry point as `make serve` - Should expose relevant ports (`EXPOSE 8080`) diff --git a/docs/requirements.txt b/docs/requirements.txt index 335cffc4c..1981d5ded 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -87,4 +87,4 @@ weasyprint>=66.0 webcolors>=24.11.1 webencodings>=0.5.1 zipp>=3.23.0 -zopfli>=0.2.3.post1 \ No newline at end of file +zopfli>=0.2.3.post1