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.

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.1.0.tar.gz (56.6 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.1.0-py3-none-any.whl (78.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xrlint-0.1.0.tar.gz
Algorithm Hash digest
SHA256 47989739eb181a5c6ac4f0d9a357469b029d05a2debaaa175bf8c56a1611be97
MD5 1650f55c11cdad896aa9cd5f5a68386b
BLAKE2b-256 fdb6102c6ccfff0301872bd5b35b699c44b79d2d8fc95ddd3dcd51de278bc0b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xrlint-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 78.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a925ce63f4dff5e7f578f2804af388a362399a65d27f66d47d3b9ba9eca68fc7
MD5 85463fbf37d68b6b78a5b1f20f77320b
BLAKE2b-256 4878a3ebd39190703df2af92780c67ad6070408aa294ee2eb890f566d7499b9b

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