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.core: 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 once XRLint is mature enough.

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.3.0.tar.gz (76.0 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.3.0-py3-none-any.whl (101.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xrlint-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8169225838f9dc4111b07d696b3d7a1fd20a734dc86a18a6750fd5868a354a9e
MD5 e865446c4333212168016393fbf6a181
BLAKE2b-256 0d7c96000fa5cf8d3d9caa77123b06f9f09d130d46f012c523317b4834218b96

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for xrlint-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b4e10f92be3d8c848a7f99920820eaa37c3474ad2edfc9cf51d04d9ca611a51
MD5 81a036c80c0c306e56327277ed36e619
BLAKE2b-256 b10f5542883f54f8bbffae90479dbc374844f2f7206df0fc23ce13b3c61afaa1

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