Skip to main content

A linter for xarray datasets.

Project description

CI codecov PyPI Version Code style: black 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.

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.

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.2.0.tar.gz (67.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.2.0-py3-none-any.whl (89.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrlint-0.2.0.tar.gz
  • Upload date:
  • Size: 67.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.2.0.tar.gz
Algorithm Hash digest
SHA256 72451b84fe12bb336ddbe12424915eeef2a3ffdc2a58e57d5eb49d7bcf37b2a5
MD5 a51b73e89768748f1df2846c9c181c26
BLAKE2b-256 f3ca189865be199ab9b893a1e6c66879d007949ebaa2f53f3d8dbeeb72a05f48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 89.5 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae6ad8c09b2bd63d80844fd31ccc30574a7804ff0ad69ae6315d35148801a6fb
MD5 7541eab836c3ce13c659d582c0e2fb38
BLAKE2b-256 7a88b3a8aea74ba2c862adad87746e33d9c4ebc405d1cf09ea668137164f6a12

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