Skip to content

bcdev/xrlint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

cbaf81a · Feb 21, 2025
Jan 20, 2025
Feb 21, 2025
Feb 15, 2025
Feb 21, 2025
Feb 21, 2025
Feb 21, 2025
Feb 21, 2025
Feb 21, 2025
Dec 30, 2024
Feb 5, 2025
Jan 6, 2025
Feb 14, 2025
Feb 13, 2025
Feb 18, 2025
Feb 13, 2025
Feb 13, 2025

Repository files navigation

CI codecov PyPI Version Conda Version Ruff GitHub License

XRLint - A linter for xarray datasets

XRLint is a linting tool and library for xarray datasets. Its design is heavily inspired by the awesome ESLint tool.

Features

  • Flexible validation for xarray.Dataset and xarray.DataTree objects by configurable rules.
  • Available from CLI and Python API.
  • Custom plugins providing custom rule sets allow addressing different dataset conventions.
  • Project-specific configurations including configuration of individual rules and file-specific settings.
  • Works with dataset files in the local filesystem or any of the remote filesystems supported by xarray.

Inbuilt Rules

The following plugins provide XRLint's inbuilt rules:

  • xrlint.plugins.core: implementing the rules for tidy data and the CF-Conventions.
  • xrlint.plugins.xcube: implementing the rules for xcube datasets. Note, this plugin is fully optional. You must manually configure it to apply its rules. It may be moved into a separate GitHub repo later.