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 ESLint.

IMPORTANT NOTE: This project just started and is under development, there is no stable release yet. See to-do list.

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 rule plugins are currently built into the code base:

  • 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.0.3.tar.gz (54.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.0.3-py3-none-any.whl (75.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xrlint-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b7f3400fdee21d8f2d5af69e59c8372adc7c20a85f03c494af9ec6fdb0b85dfd
MD5 8d337e541972798f4b0bc322d0c47251
BLAKE2b-256 6089ee4918356f1f5aa4969a6b8f0bda0f73478ffdfc13d6577422e011088281

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 75.3 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.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 77b0425bf646b6e476ee9c09c1b06c61a21beee32ffe0772e1a88b1fc15ca8c0
MD5 93971629adc6d82f85990065ce7e5359
BLAKE2b-256 943e579e7f1b2e071c963e25686b24b6d2effa39789c467a6eb9638ef8894a95

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