xarray-contrib / xncml / 14838559392

91%

push

github

Maint/modernize (#76)

This PR fixes #69.
The aim is to modernize the tooling surrounding `xncml`, including but not limited to:
- migrate from `setup.py` to `pyproject.toml`
- Make use of `ruff` instead of `flake8`, `isort`, `black`, etc.
- Use the src layout as described in https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

This also adds a `.cruft.json` file coming from the use of [cruft](https://github.com/cruft/cruft) with the [Ouranosinc template](https://github.com/Ouranosinc/cookiecutter-pypackage).
Cruft can then be used to update the project structure whenever the template is updated.
However, the `xncml` project already diverged a little from the original template:
- `CHANGES.rst` is renamed CHANGELOG.rst
- `docs/usage.rst` is superseded by `docs/tutorial.ipynb`
- `ruff` format replaces `black`

# Breaking changes
- Python3.9 has been dropped, Python3.13 support has been added.
- The build system is now using `flit` instead of setuptools.
- setup.py was removed.
- __version__ is no longer fetched from git, but is instead hardcoded in xncml/__init__.py
- All workflows have been replaced
  - Publishing to TestPyPI and PyPI are now handled via Trusted Publishing
  - Testing uses `tox` and reports directly to coveralls.io
  - Many other small changes to aid with maintainability
- Documentation now uses `sphinx-apidoc` to generate an API map that is exposed by ReadTheDocs
- ReadTheDocs builds now fail when the generation step emits any warnings (for ensuring that the documentation is always working as intended)
- `xncml.generated` no longer exposes the `ncml_2_2.py` submodule (needed to prevent multiple targets for the same re-exported functions/modules).

---------

Co-authored-by: Abel Aoun <abel.aoun@external.eumetsat.int>
Co-authored-by: Francis Charette-Migneault <francis.charette.migneault@gmail.com>
Co-authored-by: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Co-authored-by: David Huard <huard.david@ouranos.ca>

357 of 376 new or added lines in 5 files covered. (94.95%)

731 of 803 relevant lines covered (91.03%)

2.73 hits per line