Ranuk Web Accessibility & AST Security Auditor

ADA-Audits

Python プロジェクト向けの自動データアクセシビリティ監査ツールです。

📌 特長

• Python ファイルとノートブックをスキャンし、データアクセシビリティに関する問題を検出します
• docstring、型ヒント、アクセシビリティ基準の不足を検出します
• 実行可能な改善案を含むレポートを生成します
• CI/CD パイプラインと連携します

🚀 クイックスタート

ADA-Audits を使い始めるには、以下の手順に従ってください。

ステップ 1：インストール

pip を使用する場合：

# Clone the repository
git clone https://github.com/your-org/ada-audits.git
cd ada-audits

# Install in development mode
pip install -e .

Poetry を使用する場合：

# Clone the repository
git clone https://github.com/your-org/ada-audits.git
cd ada-audits

# Install dependencies with Poetry
poetry install

# Activate the virtual environment
poetry shell

ステップ 2：設定ファイルの作成

プロジェクトのルートに .ada-audit.yml ファイルを作成します。

# .ada-audit.yml - Minimal working configuration
targets:
  - src/
  - notebooks/

rules:
  - missing-docstring
  - missing-type-hint
  - accessibility-issue

output:
  format: markdown
  file: audit-report.md

ステップ 3：最初の監査を実行する

単一のファイルをスキャンする場合：

ada-scan path/to/file.py

出力例：

✓ Scanning: path/to/file.py
Found 3 issues:
  [WARNING] line 15: Missing docstring for function 'process_data'
  [WARNING] line 23: Missing type hint for parameter 'input_path'
  [ERROR]   line 45: Accessibility issue - missing alt text for image

ディレクトリ全体をスキャンする場合：

ada-scan src/

出力例：

✓ Scanning directory: src/
Found 12 files to analyze
  src/__init__.py .............. OK
  src/main.py .................. 2 issues
  src/utils.py ................. 5 issues
  src/processors/base.py ....... 1 issue
  src/processors/transform.py .. 4 issues

Summary: 12 issues found across 4 files

完全なレポートを生成する場合：

ada-audit --output report.md

出力例：

✓ ADA Audit Report Generated
  Output: report.md
  Total files scanned: 12
  Issues found: 15
  Compliance score: 78%

📖 使用方法

コマンドラインインターフェース

コマンド	説明
ada-scan <path>	ファイルまたはディレクトリをスキャンして、アクセシビリティに関する問題を検出します
ada-audit	設定に基づいて完全な監査レポートを生成します
ada-audit --output <file>	任意の出力ファイル名を指定してレポートを生成します
ada-audit --format <fmt>	出力形式：markdown、json、または html

設定リファレンス

.ada-audit.yml の設定オプションの全一覧：

# Paths to scan
targets:
  - src/              # Python source files
  - notebooks/        # Jupyter notebooks
  - tests/            # Test files

# Rules to apply
rules:
  - missing-docstring      # Functions/classes without docstrings
  - missing-type-hint      # Parameters without type annotations
  - accessibility-issue    # Accessibility standard violations

# Output settings
output:
  format: markdown         # Options: markdown, json, html
  file: audit-report.md   # Output filename

# Optional: Exclude patterns
exclude:
  - "**/__pycache__/**"
  - "**/migrations/**"

🤝 貢献

1. リポジトリをフォークします
2. 機能ブランチを作成します（git checkout -b feature/your-feature）
3. 変更をコミットします（git commit -m 'feat: add new rule [ranukita:xxxxx]'）
4. ブランチにプッシュします（git push origin feature/your-feature）
5. プルリクエストを作成します

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細は LICENSE ファイルをご覧ください。