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 tiny 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.2.tar.gz (50.7 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.2-py3-none-any.whl (70.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xrlint-0.0.2.tar.gz
  • Upload date:
  • Size: 50.7 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.2.tar.gz
Algorithm Hash digest
SHA256 bd1b21728055dc89273d968faa72b9a357546f358379e86fc082082987ca475a
MD5 2cabae8f509c53776d4f73bd66c7ae8f
BLAKE2b-256 5dbdc4f9ef0aa878b96f655044ee799323b00dc4f7a8c929359ab313ecf723f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 70.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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5be553a2e44bf490026951b4a1ed88735abcc0903ed263f09a8608be3a6ffbee
MD5 5b56f3f5bc767a383cbeb4594abb5abf
BLAKE2b-256 265d938936361c1d5d76487b0e7efbc5abbfa9a258c0930bc467d2d799aa05f3

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