Skip to main content

A linter for xarray datasets.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xrlint-0.5.1.tar.gz (96.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xrlint-0.5.1-py3-none-any.whl (147.7 kB view details)

Uploaded Python 3

File details

Details for the file xrlint-0.5.1.tar.gz.

File metadata

  • Download URL: xrlint-0.5.1.tar.gz
  • Upload date:
  • Size: 96.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for xrlint-0.5.1.tar.gz
Algorithm Hash digest
SHA256 f50e43037457ad0615638861f595da871817ece7b3cffa3ce015764fde3dffca
MD5 d500e303f5b78d9747fb8c2dc0521104
BLAKE2b-256 1d12142c69cffbd5d5ba90f31772444b9eb9907b1fde8699dc72b70f90f58e6c

See more details on using hashes here.

File details

Details for the file xrlint-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: xrlint-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 147.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for xrlint-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e5be00815a2cb107a08e744d1bb52512c9dc4d877625f72e883724280e39dce6
MD5 60bcbd0038884db6c06a1644f3435e60
BLAKE2b-256 2835002687843d4b33ce09d0f681389ea102fbb9b9c107d603a5d4616201ef06

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page