SciTeX Linter

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Verification
    • Via SciTeX
  • Quick Start
    • Lint a File
    • Severity Levels
    • Lint then Execute
    • Browse Rules
    • flake8 Integration
    • What a Clean Script Looks Like

Reference

  • Rules Reference
    • Category S: Structure
    • Category I: Imports
    • Category IO: I/O Calls
    • Category P: Plotting
    • Category ST: Statistics
    • Category PA: Path Handling
    • Category FM: Figure/Millimeter (opt-in)
    • Severity Summary
  • CLI Reference
    • Global Options
    • scitex-linter check
    • scitex-linter format
    • scitex-linter python
    • scitex-linter rule
    • scitex-linter api
    • scitex-linter mcp
  • Claude Code Hook
    • How It Works
    • Installation
    • Command Detection
    • Exit Codes
    • Example Output
    • Disabling

API Reference

  • scitex_linter
    • list_rules()
    • Submodules
      • scitex_linter.checker
        • Issue
        • is_script()
        • lint_file()
        • lint_source()
      • scitex_linter.rules
        • Rule
      • scitex_linter.formatter
        • format_issue()
        • format_summary()
        • to_json()
      • scitex_linter.runner
        • _is_git_root()
        • run_script()
      • scitex_linter.cli
        • _collect_files()
        • _print_help_recursive()
        • main()
      • scitex_linter.config
        • LinterConfig
        • load_config()
      • scitex_linter.flake8_plugin
        • SciTeXFlake8Checker
      • scitex_linter._fm_checker
        • _is_exempt_call()
        • _has_kwarg()
        • FMChecker
      • scitex_linter._packages
        • _can_import()
        • detect()
        • reset()
SciTeX Linter
  • Python Module Index

Python Module Index

s
 
s
- scitex_linter
    scitex_linter._fm_checker
    scitex_linter._packages
    scitex_linter.checker
    scitex_linter.cli
    scitex_linter.config
    scitex_linter.flake8_plugin
    scitex_linter.formatter
    scitex_linter.rules
    scitex_linter.runner

© Copyright 2025, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.