Skip to main content

A linter for xarray datasets.

Project description

CI codecov 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.

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:

  • core: Implementing the rules for tiny data and the CF-Conventions.

  • xcube: Implementing the rules for xcube datasets. Note this plugins will be moved into a separate GitHub repo later 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.1.tar.gz (37.2 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.1-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrlint-0.0.1.tar.gz
  • Upload date:
  • Size: 37.2 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.1.tar.gz
Algorithm Hash digest
SHA256 61d983593f2824312655b00a614bfd88a295fb788ee0baf1b99617a4cd342c9c
MD5 5f7b8d0ef4741eb60cd8e3702b9ad722
BLAKE2b-256 9357cdb6c593ed4e3d2d8b50f6a786ae467ad709bba9ba83fe5febcf6ae151ea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 49.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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d1fb41458c01d530c4f421ec442eafe24cd63c6ef30c99a02397cb02570b951
MD5 49056468892eaf50bfdbe12f2c77f15c
BLAKE2b-256 39acca5db95279560e222ebcfe8551770075f4d7ec92afbe89dde5df010f5dee

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