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.4.1.tar.gz (89.8 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.4.1-py3-none-any.whl (122.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xrlint-0.4.1.tar.gz
Algorithm Hash digest
SHA256 946611e6e629642a971da0ed44d92ac64ad23b8c3a745e3d53c07a88f639621d
MD5 ac8856560a68ff58c4f29ede3a9463d9
BLAKE2b-256 03ecf5966ed095fc051250296f42f21f64fc0cec98e44b72e0ea3aca11be5249

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 122.6 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35ea55feb2af422f8342f1cc9c8f1311e7f16958b797313ff0fcbb118215d80b
MD5 26c4ef84ff52d29e2a72f4dab37a0129
BLAKE2b-256 edf2a7c02c74d541320b77dad9fe3e1f574ecb2bd720b65ec0bfec69b06db2be

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