Maint/modernize

.cruft.json

@@ -0,0 +1,29 @@
+{
+  "template": "https://github.com/Ouranosinc/cookiecutter-pypackage.git",
+  "commit": "f391bbd6ee14ab2478c64a1f78b74bd9903cae81",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "Abel Aoun",
+      "email": "[email protected]",
+      "github_username": "bzah",
+      "project_name": "xncml",
+      "project_slug": "xncml",
+      "project_short_description": "Tools for manipulating NcML (NetCDF Markup Language) files with/for xarray",
+      "pypi_username": "bzah",
+      "version": "0.5.0",
+      "use_pytest": "y",
+      "use_black": "n",
+      "use_conda": "n",
+      "add_pyup_badge": "n",
+      "make_docs": "y",
+      "add_translations": "n",
+      "command_line_interface": "No command-line interface",
+      "create_author_file": "y",
+      "open_source_license": "Apache Software License 2.0",
+      "generated_with_cruft": "y",
+      "_template": "https://github.com/Ouranosinc/cookiecutter-pypackage.git"
+    }
+  },
+  "directory": null
+}

.editorconfig

@@ -0,0 +1,24 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.{yaml,yml}]
+indent_size = 2
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.flake8

@@ -0,0 +1,30 @@
+[flake8]
+exclude =
+	.eggs,
+	.git,
+	build,
+	docs,
+	tests
+ignore =
+	AZ100,
+	AZ200,
+	AZ300,
+	C,
+	D,
+	E,
+	F,
+	W503
+per-file-ignores =
+rst-roles =
+	doc,
+	mod,
+	py:attr,
+	py:attribute,
+	py:class,
+	py:const,
+	py:data,
+	py:func,
+	py:meth,
+	py:mod,
+	py:obj,
+	py:ref

.pre-commit-config.yaml

@@ -2,7 +2,6 @@ default_language_version:
   python: python3
 
 repos:
-
   -   repo: https://github.com/pre-commit/pre-commit-hooks
       rev: v4.6.0
       hooks:
@@ -11,25 +10,47 @@ repos:
       -   id: check-docstring-first
       -   id: check-json
       -   id: check-yaml
+      -   id: check-toml
       -   id: double-quote-string-fixer
-
-  -   repo: https://github.com/psf/black-pre-commit-mirror
-      rev: 24.3.0
+  -   repo: https://github.com/pappasam/toml-sort
+      rev: v0.23.1
       hooks:
-      - id: black
-        args: ["--line-length", "100", "--skip-string-normalization"]
-
-  -   repo: https://github.com/PyCQA/flake8
+      -   id: toml-sort-fix
+  -   repo: https://github.com/pre-commit/pygrep-hooks
+      rev: v1.10.0
+      hooks:
+      -   id: python-check-blanket-noqa
+      -   id: python-no-eval
+      -   id: python-no-log-warn
+      -   id: python-use-type-annotations
+      -   id: rst-inline-touching-normal
+  -   repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.3.7
+      hooks:
+      -   id: ruff
+          args: [ --fix ]
+      -   id: ruff-format
+  -   repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.3.7
+      hooks:
+      -   id: ruff
+  -   repo: https://github.com/pycqa/flake8
       rev: 7.0.0
       hooks:
-      - id: flake8
-
-  -   repo: https://github.com/asottile/seed-isort-config
-      rev: v2.2.0
+      -   id: flake8
+          additional_dependencies: [ 'flake8-alphabetize', 'flake8-rst-docstrings' ]
+          args: [ '--config=.flake8' ]
+  -   repo: https://github.com/adrienverge/yamllint.git
+      rev: v1.35.1
       hooks:
-      -   id: seed-isort-config
-
-  -   repo: https://github.com/PyCQA/isort
-      rev: 5.13.2
+      -   id: yamllint
+          args: [ '--config-file=.yamllint.yaml' ]
+  -   repo: https://github.com/python-jsonschema/check-jsonschema
+      rev: 0.28.2
+      hooks:
+      -   id: check-github-workflows
+      -   id: check-readthedocs
+  -   repo: meta
       hooks:
-      -   id: isort
+      -   id: check-hooks-apply
+      -   id: check-useless-excludes

.readthedocs.yml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+   configuration: docs/conf.py
 
 # Optionally set the version of Python and requirements required to build your docs
 conda:

.yamllint.yaml

@@ -0,0 +1,8 @@
+---
+
+rules:
+  document-start: disable
+  line-length:
+    max: 120
+    level: warning
+  truthy: disable

AUTHORS.rst

@@ -0,0 +1,17 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Anderson Banihirwe <[email protected]> `@andersy005 <https://github.com/andersy005>`_
+* David Huard <[email protected]> `@huard <https://github.com/huard>`_
+
+Contributors
+-------------
+
+* Trevor James Smith `@Zeitsperre <https://github.com/Zeitsperre>`_
+* Pascal Bourgault <[email protected]> `@Zeitsperre <https://github.com/Zeitsperre>`_
+* Francis Charette-Migneault <[email protected]> `@fmigneault <https://github.com/fmigneault>`_
+* Abel Aoun <[email protected]> `@bzah <https://github.com/bzah>`_

CHANGELOG.md → CHANGELOG.rst

@@ -1,5 +1,8 @@
+Changelog
+=========
+
 0.5.0 (unreleased)
-==================
+------------------
 
 - Added support for running `pytest` with `pytest-cov`. By @Zeitsperre
 - Reworked the GitHub CI testing workflow to perform version checks as well as tests with `pytest-cov` . By @Zeitsperre
@@ -12,23 +15,22 @@ Breaking changes
 - [fix] scalar attributes that are not strings are no longer wrapped in tuples of length 1.
 
 0.4.0 (2024-01-08)
-==================
+------------------
 
 - Add support for <EnumTypeDef>. By @bzah
-- Update XSD schema and dataclasses to latest version from netcdf-java to add support
-  for unsigned types. By @bzah
+- Update XSD schema and dataclasses to latest version from netcdf-java to add support for unsigned types. By @bzah
 - Add support for scalar variables. By @Bzah
 - [fix] empty attributes are now parsed into an empty string instead of crashing the parser.  By @Bzah
 
 0.3.1 (2023-11-10)
-==================
+------------------
 
 - Add support for Python 3.12
 - Drop support for Python 3.8
 
 
 0.3 (2023-08-28)
-================
+----------------
 
 - Add `add_aggregation` and `add_variable_agg` to `Dataset` class. By @huard
 - Add `add_scan` to `Dataset` class. By @huard
@@ -37,7 +39,7 @@ Breaking changes
 
 
 0.2 (2023-02-23)
-================
+----------------
 
 - Implement `Dataset.rename_dataset_attribute`. By @huard
 - Allow empty `Dataset` creation. By @huard
@@ -46,7 +48,7 @@ Breaking changes
 
 
 0.1 Initial release (2022-11-24)
-================================
+--------------------------------
 
  - Manipulate NcML file: add & remove attributes, variables and dimensions. By @andersy005
  - Implement `open_ncml`, which returns an `xarray.Dataset` built from an NcML. Note that