ruff-sync 0.0.5.dev1__tar.gz → 0.1.0.dev0__tar.gz

{ruff_sync-0.0.5.dev1 → ruff_sync-0.1.0.dev0}/.github/workflows/ci.yaml

@@ -66,8 +66,10 @@ jobs:
 
   pre-publish:
     name: Test package installation
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     needs: [static-analysis, tests]
+    if: >-
+      (github.event_name == 'push' && github.ref == 'refs/heads/main') ||
+      (github.event_name == 'pull_request' && github.event.pull_request.draft == false)
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -80,14 +82,29 @@ jobs:
         run: uv python install 3.10
 
       - name: Build package
-        run: uv build
+        run: |
+          echo "Building ruff-sync package..."
+          uv build
 
-      - name: Install and test packaged program
+      - name: Install packaged program
         run: |
+          echo "Installing built wheel..."
           uv tool install $(ls dist/*.whl)
-          ruff-sync --version
+          echo "Version: $(ruff-sync --version)"
+
+      - name: Test package installation (Pull)
+        run: |
+          echo "Testing ruff-sync pull against Kilo59/ruff-sync..."
           ruff-sync https://github.com/Kilo59/ruff-sync
+
+      - name: Test package installation (Check)
+        run: |
+          echo "Testing ruff-sync check against Kilo59/ruff-sync..."
           ruff-sync check https://github.com/Kilo59/ruff-sync
+
+      - name: Verify semantic check failure
+        run: |
+          echo "Verifying that --semantic check fails for kitchen-sink config (expected failure)..."
           ! ruff-sync check --semantic https://github.com/Kilo59/ruff-sync --path configs/kitchen-sink
 
   publish:

{ruff_sync-0.0.5.dev1 → ruff_sync-0.1.0.dev0}/.github/workflows/complexity.yaml

@@ -12,14 +12,13 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: ${{ github.event.pull_request.head.ref }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Install Wily
         run: pip install 'wily>=1.25.0'
       - name: Build cache and diff
@@ -29,30 +28,26 @@ jobs:
           DIFF=$(wily diff ruff_sync.py tasks.py tests/ --no-detail -r origin/${{ github.event.pull_request.base.ref }})
           echo "$DIFF"
 
-          # Build multine output
-          DIFF="${DIFF//'%'/'%25'}"
-          DIFF="${DIFF//$'\n'/'%0A'}"
-          DIFF="${DIFF//$'\r'/'%0D'}"
-          echo "::set-output name=diff::$DIFF"
-      - name: Find current PR
-        uses: jwalton/gh-find-current-pr@v1
-        id: findPr
+          # Build multiline output
+          echo "diff<<DIFF_EOF" >> "$GITHUB_OUTPUT"
+          echo "$DIFF" >> "$GITHUB_OUTPUT"
+          echo "DIFF_EOF" >> "$GITHUB_OUTPUT"
       - name: Add Wily PR Comment
         uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.findPr.outputs.number && steps.wily.outputs.diff != ''
+        if: github.event.pull_request.head.repo.full_name == github.repository && github.event.pull_request.number && steps.wily.outputs.diff != ''
         with:
           recreate: true
-          number: ${{ steps.findPr.outputs.number }}
+          number: ${{ github.event.pull_request.number }}
           message: |
             ```
             ${{ steps.wily.outputs.diff }}
             ```
       - name: Add Wily PR Comment
         uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.findPr.outputs.number && steps.wily.outputs.diff == ''
+        if: github.event.pull_request.head.repo.full_name == github.repository && github.event.pull_request.number && steps.wily.outputs.diff == ''
         with:
           recreate: true
-          number: ${{ steps.findPr.outputs.number }}
+          number: ${{ github.event.pull_request.number }}
           message: |
             ```
             Wily: No changes in complexity detected.

ruff_sync-0.1.0.dev0/.github/workflows/docs.yaml

@@ -0,0 +1,32 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev --group docs
+
+      - name: Build and deploy documentation
+        run: uv run mkdocs gh-deploy --force

{ruff_sync-0.0.5.dev1 → ruff_sync-0.1.0.dev0}/AGENTS.md

@@ -5,7 +5,7 @@
 **ruff-sync** is a CLI tool that synchronizes [Ruff](https://docs.astral.sh/ruff/) linter configuration across multiple Python projects. It downloads an upstream `pyproject.toml`, extracts the `[tool.ruff]` section, and merges it into a local project's `pyproject.toml` while preserving formatting, comments, and whitespace.
 
 - **GitHub Repository**: [`Kilo59/ruff-sync`](https://github.com/Kilo59/ruff-sync)
-- The entire application lives in a single module: `ruff_sync.py`.
+- The application uses a `src` layout in `src/ruff_sync/`.
 - Dev tasks are defined in `tasks.py` using [Invoke](https://www.pyinvoke.org/).
 
 ## GitHub Context
@@ -54,11 +54,14 @@ gh label list                           # See available labels
 
 ## Project Structure
 
-```
+```text
 .agents/               # Agent-specific instructions (Deep Standards)
   TESTING.md           # Mandatory testing patterns and rules
   workflows/           # Step-by-step guides for common tasks
-ruff_sync.py           # The entire application — CLI, merging logic, HTTP
+src/ruff_sync/         # The application source
+  __init__.py          # Public API
+  cli.py               # CLI, merging logic, HTTP
+  __main__.py          # -m support
 tasks.py               # Invoke tasks: lint, fmt, type-check, deps, new-case
 pyproject.toml         # Project config, dependencies, ruff/mypy settings
 tests/
@@ -114,7 +117,7 @@ uv run mypy .
 ```
 
 - mypy is configured in strict mode with `python_version = "3.10"`.
-- It checks `ruff_sync.py`, `tests/`, and `tasks.py`.
+- It checks `src/`, `tests/`, and `tasks.py`.
 - Tests have relaxed rules: `type-arg` and `no-untyped-def` are disabled for `tests.*`.
 - `tomlkit` returns complex union types — use `cast(Any, ...)` in tests when indexing parsed TOML documents to satisfy mypy without verbose type narrowing.
 
@@ -130,7 +133,7 @@ Or with coverage:
 uv run coverage run -m pytest -vv
 ```
 
-- Coverage is tracked for `ruff_sync.py` only.
+- Coverage is tracked for `src/ruff_sync/` only.
 - Tests use `respx` to mock HTTP calls and `pyfakefs` for filesystem mocking.
 - `pytest-asyncio` is in **strict** mode — async tests need the `@pytest.mark.asyncio` decorator.
 
@@ -165,13 +168,13 @@ uv run coverage run -m pytest -vv
 
 Defined in `tasks.py`. **ALWAYS** run these through uv: `uv run invoke <task>`
 
-| Task         | Alias        | Description                         |
-| ------------ | ------------ | ----------------------------------- |
-| `lint`       |              | Lint with ruff (auto-fixes by default) |
-| `fmt`        |              | Format with ruff format             |
-| `type-check` | `types`      | Type-check with mypy                |
-| `deps`       | `sync`       | Sync dependencies with uv           |
-| `new-case`   | `new-lifecycle-tomls` | Scaffold lifecycle TOML fixtures (See [Workflow](.agents/workflows/add-test-case.md)) |
+| Task         | Alias                 | Description                            |
+| ------------ | --------------------- | -------------------------------------- |
+| `lint`       |                       | Lint with ruff (auto-fixes by default) |
+| `fmt`        |                       | Format with ruff format                |
+| `type-check` | `types`               | Type-check with mypy                   |
+| `deps`       | `sync`                | Sync dependencies with uv              |
+| `new-case`   | `new-lifecycle-tomls` | Scaffold lifecycle TOML fixtures       |
 
 ## CI
 

{ruff_sync-0.0.5.dev1 → ruff_sync-0.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ruff-sync
-Version: 0.0.5.dev1
+Version: 0.1.0.dev0
 Summary: Synchronize Ruff linter configuration across projects
 Project-URL: Homepage, https://github.com/Kilo59/ruff-sync
 Project-URL: Documentation, https://github.com/Kilo59/ruff-sync#readme
@@ -26,6 +26,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.10
 Requires-Dist: httpx<1.0.0,>=0.27.0
 Requires-Dist: tomlkit<2.0.0,>=0.12.3
+Requires-Dist: typing-extensions>=4.5.0
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -46,7 +47,7 @@ Description-Content-Type: text/markdown
 
 ---
 
-### Table of Contents
+## Table of Contents
 
 - [The Problem](#the-problem)
 - [How It Works](#how-it-works)
@@ -56,7 +57,6 @@ Description-Content-Type: text/markdown
 - [CI Integration](#ci-integration)
 - [Example Workflow](#example-workflow)
 - [Detailed Check Logic](#detailed-check-logic)
-- [Contributing](#contributing)
 - [Dogfooding](#dogfooding)
 - [License](#license)
 
@@ -102,9 +102,9 @@ Ruff's `extend` is perfect inside a monorepo, but if your projects live in **sep
 └─────────────────────────────┘
 ```
 
-1. You point `ruff-sync` at the URL of your canonical `pyproject.toml`.
-2. It downloads the file, extracts the `[tool.ruff]` section.
-3. It **merges** the upstream config into your local `pyproject.toml` — updating values that changed, adding new rules, but preserving your local comments, whitespace, and any sections you've chosen to exclude (like `per-file-ignores`).
+1. You point `ruff-sync` at the URL of your canonical configuration (repository, directory, or direct file).
+2. It downloads the file and extracts the configuration (from `[tool.ruff]` in `pyproject.toml` or the top-level in `ruff.toml`).
+3. It **merges** the upstream config into your local project — updating values that changed, adding new rules, but preserving your local comments, whitespace, and any sections you've chosen to exclude (like `per-file-ignores`).
 
 No package registry. No publishing step. Just a URL.
 
@@ -133,8 +133,9 @@ pip install ruff-sync
 ### Usage
 
 ```console
-# Sync from a GitHub/GitLab repository (defaults to main/pyproject.toml)
+# Sync from a GitHub/GitLab repository (root or specific directory)
 ruff-sync https://github.com/my-org/standards
+ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
 
 # Or a direct blob/file URL (auto-converts to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
@@ -162,7 +163,8 @@ Run `ruff-sync --help` for full details on all available options.
 ## Key Features
 
 - 🏗️ **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
-- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
+- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs, tree (directory) URLs, or blob (file) URLs to raw content URLs.
+- 🔍 **Smart configuration discovery** — Point at a directory and `ruff-sync` will automatically find your config. It checks `pyproject.toml`, `ruff.toml`, and `.ruff.toml` (in that order).
 - 📥 **Git clone support** — If the URL starts with `git@` or uses the `ssh://`, `git://`, or `git+ssh://` schemes, `ruff-sync` will perform an efficient shallow clone (using `--filter=blob:none` and `--no-checkout`) to safely extract the configuration with minimal network traffic.
 - 🛡️ **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
 - 🌍 **Works with any host** — GitHub, GitLab, Bitbucket, private SSH servers, or any raw URL that serves a `pyproject.toml` or `ruff.toml`.
@@ -190,7 +192,7 @@ exclude = [
 ```
 
 This sets the default upstream and exclusions so you don't need to pass them on the command line every time.
-*Note: Any explicitly provided CLI arguments will override the values in `pyproject.toml`.*
+_Note: Any explicitly provided CLI arguments will override the values in `pyproject.toml`._
 
 ### Advanced Configuration
 
@@ -212,8 +214,11 @@ exclude = [
 branch = "develop"
 
 # A directory prefix to use when looking for a configuration file in a repository. (Default: "")
-# Useful if the upstream pyproject.toml is not at the repository root.
+# Useful if the upstream config is not at the repository root.
 path = "config/ruff"
+
+# The local target directory or file to sync into. (Default: ".")
+to = "."
 ```
 
 ## CI Integration
@@ -262,20 +267,48 @@ git commit -am "sync ruff config from upstream"
 
 ### Curated Examples
 
-While `ruff-sync` is designed to sync from *any* repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+While `ruff-sync` is designed to sync from _any_ repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+
+`ruff-sync` is flexible with URLs. You can point it at a repository root, a specific directory (tree), a direct file (blob), or even a raw content URL.
 
-For example, to sync an exhaustive "kitchen-sink" configuration that explicitly enables all rules and documents them:
+#### Kitchen Sink
+
+An exhaustive configuration that explicitly enables and documents almost all available Ruff rules. Great for establishing a strict baseline.
 
 ```console
+# Directory URL (recommended)
+ruff-sync https://github.com/Kilo59/ruff-sync/tree/main/configs/kitchen-sink
+
+# Direct file URL (blob)
 ruff-sync https://github.com/Kilo59/ruff-sync/blob/main/configs/kitchen-sink/ruff.toml
+
+# Raw content URL
+ruff-sync https://raw.githubusercontent.com/Kilo59/ruff-sync/main/configs/kitchen-sink/ruff.toml
+
+# Git SSH URL (clones the repo)
+ruff-sync git@github.com:Kilo59/ruff-sync.git --path configs/kitchen-sink
+```
+
+#### FastAPI & Async
+
+Tailored for modern web applications. Includes rules for `asyncio`, security (`flake8-bandit`), and Pydantic-friendly naming conventions.
+
+```console
+# Repository Root (if the config is at the root)
+ruff-sync https://github.com/my-org/fastapi-standards
+
+# Directory URL
+ruff-sync https://github.com/Kilo59/ruff-sync/tree/main/configs/fastapi
 ```
 
-Or configure it using `pyproject.toml` so it's always the default for your local project:
+#### Default Syncing
+
+Set your preferred standard as the default in your `pyproject.toml`:
 
 ```toml
 [tool.ruff-sync]
 upstream = "https://github.com/Kilo59/ruff-sync"
-path = "configs/kitchen-sink"
+path = "configs/fastapi"
 ```
 
 ## Bootstrapping a New Project
@@ -287,8 +320,7 @@ By default, `ruff-sync` requires an existing configuration file (`pyproject.toml
 ruff-sync pull https://github.com/my-org/standards --init
 ```
 
-`ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
-
+`ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your local target is a directory, it will look for configuration files in the following order: `ruff.toml` -> `.ruff.toml` -> `pyproject.toml`. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
 
 ## Detailed Check Logic
 
@@ -296,9 +328,9 @@ When you run `ruff-sync check`, it follows this process to determine if your pro
 
 ```mermaid
 flowchart TD
-    Start([Start]) --> Local[Read Local pyproject.toml]
-    Local --> Upstream[Download Upstream pyproject.toml]
-    Upstream --> Extract[Extract tool.ruff section]
+    Start([Start]) --> Local[Read Local Configuration]
+    Local --> Upstream[Download Upstream Configuration]
+    Upstream --> Extract[Extract tool.ruff section if needed]
     Extract --> Exclude[Apply Exclusions]
     Exclude --> Merge[Perform in-memory Merge]
 

{ruff_sync-0.0.5.dev1 → ruff_sync-0.1.0.dev0}/README.md

@@ -16,7 +16,7 @@
 
 ---
 
-### Table of Contents
+## Table of Contents
 
 - [The Problem](#the-problem)
 - [How It Works](#how-it-works)
@@ -26,7 +26,6 @@
 - [CI Integration](#ci-integration)
 - [Example Workflow](#example-workflow)
 - [Detailed Check Logic](#detailed-check-logic)
-- [Contributing](#contributing)
 - [Dogfooding](#dogfooding)
 - [License](#license)
 
@@ -72,9 +71,9 @@ Ruff's `extend` is perfect inside a monorepo, but if your projects live in **sep
 └─────────────────────────────┘
 ```
 
-1. You point `ruff-sync` at the URL of your canonical `pyproject.toml`.
-2. It downloads the file, extracts the `[tool.ruff]` section.
-3. It **merges** the upstream config into your local `pyproject.toml` — updating values that changed, adding new rules, but preserving your local comments, whitespace, and any sections you've chosen to exclude (like `per-file-ignores`).
+1. You point `ruff-sync` at the URL of your canonical configuration (repository, directory, or direct file).
+2. It downloads the file and extracts the configuration (from `[tool.ruff]` in `pyproject.toml` or the top-level in `ruff.toml`).
+3. It **merges** the upstream config into your local project — updating values that changed, adding new rules, but preserving your local comments, whitespace, and any sections you've chosen to exclude (like `per-file-ignores`).
 
 No package registry. No publishing step. Just a URL.
 
@@ -103,8 +102,9 @@ pip install ruff-sync
 ### Usage
 
 ```console
-# Sync from a GitHub/GitLab repository (defaults to main/pyproject.toml)
+# Sync from a GitHub/GitLab repository (root or specific directory)
 ruff-sync https://github.com/my-org/standards
+ruff-sync https://github.com/my-org/standards/tree/main/configs/shared
 
 # Or a direct blob/file URL (auto-converts to raw)
 ruff-sync https://github.com/my-org/standards/blob/main/pyproject.toml
@@ -132,7 +132,8 @@ Run `ruff-sync --help` for full details on all available options.
 ## Key Features
 
 - 🏗️ **Format-preserving merges** — Uses [tomlkit](https://github.com/sdispater/tomlkit) under the hood, so your comments, whitespace, and TOML structure are preserved. No reformatting surprises.
-- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs or blob URLs to raw content URLs.
+- 🌐 **GitHub & GitLab URL support** — Automatically converts GitHub/GitLab repository URLs, tree (directory) URLs, or blob (file) URLs to raw content URLs.
+- 🔍 **Smart configuration discovery** — Point at a directory and `ruff-sync` will automatically find your config. It checks `pyproject.toml`, `ruff.toml`, and `.ruff.toml` (in that order).
 - 📥 **Git clone support** — If the URL starts with `git@` or uses the `ssh://`, `git://`, or `git+ssh://` schemes, `ruff-sync` will perform an efficient shallow clone (using `--filter=blob:none` and `--no-checkout`) to safely extract the configuration with minimal network traffic.
 - 🛡️ **Selective exclusions** — Keep project-specific overrides (like `per-file-ignores` or `target-version`) from being clobbered by the upstream config.
 - 🌍 **Works with any host** — GitHub, GitLab, Bitbucket, private SSH servers, or any raw URL that serves a `pyproject.toml` or `ruff.toml`.
@@ -160,7 +161,7 @@ exclude = [
 ```
 
 This sets the default upstream and exclusions so you don't need to pass them on the command line every time.
-*Note: Any explicitly provided CLI arguments will override the values in `pyproject.toml`.*
+_Note: Any explicitly provided CLI arguments will override the values in `pyproject.toml`._
 
 ### Advanced Configuration
 
@@ -182,8 +183,11 @@ exclude = [
 branch = "develop"
 
 # A directory prefix to use when looking for a configuration file in a repository. (Default: "")
-# Useful if the upstream pyproject.toml is not at the repository root.
+# Useful if the upstream config is not at the repository root.
 path = "config/ruff"
+
+# The local target directory or file to sync into. (Default: ".")
+to = "."
 ```
 
 ## CI Integration
@@ -232,20 +236,48 @@ git commit -am "sync ruff config from upstream"
 
 ### Curated Examples
 
-While `ruff-sync` is designed to sync from *any* repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+While `ruff-sync` is designed to sync from _any_ repository or URL of your choosing, this repository also provides a few curated configurations in the [`configs/`](./configs/) directory that you can use directly.
+
+`ruff-sync` is flexible with URLs. You can point it at a repository root, a specific directory (tree), a direct file (blob), or even a raw content URL.
 
-For example, to sync an exhaustive "kitchen-sink" configuration that explicitly enables all rules and documents them:
+#### Kitchen Sink
+
+An exhaustive configuration that explicitly enables and documents almost all available Ruff rules. Great for establishing a strict baseline.
 
 ```console
+# Directory URL (recommended)
+ruff-sync https://github.com/Kilo59/ruff-sync/tree/main/configs/kitchen-sink
+
+# Direct file URL (blob)
 ruff-sync https://github.com/Kilo59/ruff-sync/blob/main/configs/kitchen-sink/ruff.toml
+
+# Raw content URL
+ruff-sync https://raw.githubusercontent.com/Kilo59/ruff-sync/main/configs/kitchen-sink/ruff.toml
+
+# Git SSH URL (clones the repo)
+ruff-sync git@github.com:Kilo59/ruff-sync.git --path configs/kitchen-sink
+```
+
+#### FastAPI & Async
+
+Tailored for modern web applications. Includes rules for `asyncio`, security (`flake8-bandit`), and Pydantic-friendly naming conventions.
+
+```console
+# Repository Root (if the config is at the root)
+ruff-sync https://github.com/my-org/fastapi-standards
+
+# Directory URL
+ruff-sync https://github.com/Kilo59/ruff-sync/tree/main/configs/fastapi
 ```
 
-Or configure it using `pyproject.toml` so it's always the default for your local project:
+#### Default Syncing
+
+Set your preferred standard as the default in your `pyproject.toml`:
 
 ```toml
 [tool.ruff-sync]
 upstream = "https://github.com/Kilo59/ruff-sync"
-path = "configs/kitchen-sink"
+path = "configs/fastapi"
 ```
 
 ## Bootstrapping a New Project
@@ -257,8 +289,7 @@ By default, `ruff-sync` requires an existing configuration file (`pyproject.toml
 ruff-sync pull https://github.com/my-org/standards --init
 ```
 
-`ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
-
+`ruff-sync` seamlessly supports both `pyproject.toml` and standalone `ruff.toml` (or `.ruff.toml`) files. If your local target is a directory, it will look for configuration files in the following order: `ruff.toml` -> `.ruff.toml` -> `pyproject.toml`. If your upstream source or your local target is a `ruff.toml`, it will automatically adapt and sync the root configuration rather than looking for a `[tool.ruff]` section.
 
 ## Detailed Check Logic
 
@@ -266,9 +297,9 @@ When you run `ruff-sync check`, it follows this process to determine if your pro
 
 ```mermaid
 flowchart TD
-    Start([Start]) --> Local[Read Local pyproject.toml]
-    Local --> Upstream[Download Upstream pyproject.toml]
-    Upstream --> Extract[Extract tool.ruff section]
+    Start([Start]) --> Local[Read Local Configuration]
+    Local --> Upstream[Download Upstream Configuration]
+    Upstream --> Extract[Extract tool.ruff section if needed]
     Extract --> Exclude[Apply Exclusions]
     Exclude --> Merge[Perform in-memory Merge]
 

ruff_sync-0.1.0.dev0/configs/fastapi/ruff.toml

@@ -0,0 +1,150 @@
+# ruff-sync FastAPI Configuration
+# https://github.com/Kilo59/ruff-sync
+#
+# This is a Ruff configuration tailored for FastAPI / Web App development.
+# It enables rules directly relevant to web development and async Python.
+#
+# Usage (direct Ruff config, assuming this file is vendored into your repo):
+#   extend = "configs/fastapi/ruff.toml"
+#
+# Usage (with ruff-sync in pyproject.toml):
+#   [tool.ruff-sync]
+#   path = "configs/fastapi/ruff.toml"
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10. Consumers should override this to match their project's Python version.
+target-version = "py310"
+
+[lint]
+# Enable rules relevant to web development and async Python.
+select = [
+    # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F",     # Pyflakes: Essential checks for Python bugs
+    # https://docs.astral.sh/ruff/rules/#error-e
+    "E",     # pycodestyle errors: PEP8 styling
+    # https://docs.astral.sh/ruff/rules/#warning-w
+    "W",     # pycodestyle warnings: PEP8 styling
+    # https://docs.astral.sh/ruff/rules/#mccabe-c90
+    "C90",   # mccabe: Code complexity (cyclomatic complexity)
+    # https://docs.astral.sh/ruff/rules/#isort-i
+    "I",     # isort: Import sorting
+    # https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "N",     # pep8-naming: Naming conventions
+    # https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "D",     # pydocstyle: Docstring conventions
+    # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "UP",    # pyupgrade: Upgrade syntax for newer Python versions
+    # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+    "ANN",   # flake8-annotations: Type annotation checks
+    # https://docs.astral.sh/ruff/rules/#flake8-async-async
+    "ASYNC", # flake8-async: Asynchronous code checks
+    # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
+    "S",     # flake8-bandit: Security testing
+    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "B",     # flake8-bugbear: Finding likely bugs and design problems
+    # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
+    "PIE",   # flake8-pie: Misc. lints
+    # https://docs.astral.sh/ruff/rules/#flake8-print-t20
+    "T20",   # flake8-print: Check for Print statements
+    # https://docs.astral.sh/ruff/rules/#flake8-return-ret
+    "RET",   # flake8-return: Check return values
+    # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "SIM",   # flake8-simplify: Code simplification
+    # https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
+    "G",     # flake8-logging-format: Validate logging format strings
+    # https://docs.astral.sh/ruff/rules/#flake8-quotes-q
+    "Q",     # flake8-quotes: Lint for quotes
+    # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
+    "PT",    # flake8-pytest-style: Pytest style checks
+    # https://docs.astral.sh/ruff/rules/#pylint-pl
+    "PL",    # Pylint: Pylint rules
+]
+
+# Ignore rules that conflict with the Ruff formatter.
+# See: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+ignore = [
+    "W191",  # tab-indentation
+    "E111",  # indentation-with-invalid-multiple
+    "E114",  # indentation-with-invalid-multiple-comment
+    "E117",  # over-indented
+    "D206",  # docstring-tab-indentation
+    "D300",  # triple-single-quotes
+    "Q000",  # bad-quotes-inline-string
+    "Q001",  # bad-quotes-multiline-string
+    "Q002",  # bad-quotes-docstring
+    "Q003",  # avoidable-escaped-quote
+    "Q004",  # unnecessary-escaped-quote
+    "COM812",    # missing-trailing-comma
+    "COM819",    # prohibited-trailing-comma
+    "ISC001",    # single-line-implicit-string-concatenation
+    "ISC002",    # multi-line-implicit-string-concatenation
+]
+
+# Allow autofix for all enabled rules.
+fixable = ["ALL"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.mccabe]
+# Flag errors (C901) whenever the complexity level exceeds 10.
+# Default: 10
+max-complexity = 10
+
+[lint.pydocstyle]
+# Use Google-style docstrings (common in FastAPI projects).
+# Default: "pep257"
+convention = "google"
+
+[lint.flake8-quotes]
+# Use double quotes for inline strings (same as Black).
+# Default: "double"
+inline-quotes = "double"
+# Use double quotes for multiline strings.
+# Default: "double"
+multiline-quotes = "double"
+# Use double quotes for docstrings.
+# Default: "double"
+docstring-quotes = "double"
+# Avoid escaping quotes if the other quote type would save an escape.
+# Default: true
+avoid-escape = true
+
+[lint.flake8-pytest-style]
+# Whether to require parentheses for pytest fixtures.
+# Default: true
+fixture-parentheses = true
+# The type of pytest.mark.parametrize names to use: "tuple", "list", or "csv"
+# Default: "tuple"
+parametrize-names-type = "tuple"
+
+[lint.pylint]
+# The maximum number of arguments allowed for a function.
+# Default: 5
+max-args = 5
+# The maximum number of branches allowed for a function.
+# Default: 12
+max-branches = 12
+
+[lint.pep8-naming]
+# Additional decorators that should be treated as classmethod.
+# Pydantic v1/v2 decorators.
+classmethod-decorators = [
+    "pydantic.validator",
+    "pydantic.root_validator",
+    "pydantic.field_validator",
+    "pydantic.model_validator",
+]
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"