Skip to main content

A linter for xarray datasets.

Project description

CI codecov PyPI Version RuffGitHub 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.

Features

  • Flexible validation for xarray.Dataset 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.0.tar.gz (95.1 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.0-py3-none-any.whl (146.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrlint-0.5.0.tar.gz
  • Upload date:
  • Size: 95.1 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.0.tar.gz
Algorithm Hash digest
SHA256 561028df07a7dc46e456cbf0f6511a5cfa6aeb5dd41abd6a558e29ea2e987c3f
MD5 98e9f860e31362601f7039bd3002d008
BLAKE2b-256 fbfd53cd287ec822acbb93e6b2af04274205905548a7c51d2beb2a41c5c55b72

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 146.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc9434fe873c0b303fc836f205568156d10b4218cbff3069d0d7049d46106e84
MD5 43441ce4c1e6b2ea22d65ad8661d4b7a
BLAKE2b-256 bf0239f9068ec9d425f68e09759d38f6b8d461fe9b2e49ed726203eaa0f9131f

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