ruff-setup

Set up Ruff in Python projects with uv, ruff.toml, and .gitignore.

Updated Jun 18, 2025
One-click install
npx skills add https://github.com/ekozmdev/my-codex-cli-settings --skill ruff-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ruff-setup
Source: https://github.com/ekozmdev/my-codex-cli-settings/tree/main/.agents/skills/ruff-setup
Command: npx skills add https://github.com/ekozmdev/my-codex-cli-settings --skill ruff-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

PythonプロジェクトでRuffを導入・設定する際の手間を削減し、コード品質を安定させます。

Core Features & Use Cases

  • Ruffのインストール(開発依存として)と設定ファイルの配置を一括で行う。
  • .gitignoreにRuffのキャッシュディレクトリを追加して再現性を確保する。
  • 複数プロジェクトで共通の設定を適用する際の実務的な活用事例をサポートする。

Quick Start

Use uv to add Ruff as a development dependency and place the ruff.toml at the project root; copy and adjust settings from assets/ruff.toml as needed.

Frequently Asked Questions about ruff-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Ruff setup in a Python project using uv?

Automating Ruff setup with uv involves adding Ruff as a development dependency, placing a ruff.toml configuration file at the project root, and updating .gitignore to exclude Ruff cache directories.

What is the best way to configure Ruff for consistent Python code quality?

Configuring Ruff for Python code quality requires placing a ruff.toml file in your project root to centralize linting rules and ensuring the cache directory is ignored in .gitignore to maintain reproducible development environments.

How do I add Ruff as a development dependency without affecting my production environment?

Adding Ruff as a development dependency using uv isolates linting tools from production packages, ensuring code quality checks run locally without bloating the final application deployment.

Why should I ignore Ruff caches in .gitignore?

Ignoring Ruff caches in .gitignore prevents local linting cache directories from being committed to version control, maintaining a clean repository and ensuring consistent behavior across different development machines.

Can I apply a common Ruff configuration across multiple Python projects?

Applying a common Ruff configuration across multiple Python projects is supported by copying and adjusting a standardized ruff.toml file, ensuring uniform linting and code quality rules are enforced consistently.