Housekeeping

[Zeitsperre]

Hello!

This is a draft PR to update some of the GitHub workflows to use the conventions and regenerate the boilerplate code using https://github.com/Ouranosinc/cookiecutter-pypackage and cruft for versioning of the boilerplate.

There will be many merge conflicts that I will resolve, and xhydro will benefit from an updated/consistent cookiecutter recipe, pre-commit configuration, updated documentation, etc.

I am currently waiting on a PR review before moving forward with those changes: Ouranosinc/cookiecutter-pypackage#20

Questions

• sphinx-pangeo-theme has been unmaintained for 4+ years and is not used in the docs, are we safe to remove it?
• I noticed some GitLab files mentioned. Is there a GitLab mirror of this repo?
• Requirements mirror xclim very closely; Am I free to remove most of these? We can add back in the relevant requirements as code is added to the repo.
• Are the documentation dependencies listed in environment.yml based on existing notebooks? If they are only anticipated to be useful, can we comment many of these out?

[Zeitsperre]

Hello! (PVI @lpcaron)

I was able to update the cookiecutter this week and have regenerated the boilerplate code here. There are still some finishing touches to do on my side, but code reviews are welcome.

There's a lot going on here, but these are the key points:

Changes

This PR adds several new features:

• We now have issue templates (see: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository).
• We now have a pre-commit configuration (https://pre-commit.com/) with the potential to add automated checks/corrections on GitHub via pre-commit CI.
• We now have a testing workflow in place for synchronous builds of xhydro using different Python versions (3.8 to 3.11) and code coverage (using Coveralls.io).
  • I've commented out the tox testing steps and added a "smoke test" just to make sure that the package can be installed and has metadata. Once we have a suite of tests, we can/must replace this.
• Documentation content is much more current and suggests more modern approaches.
• The built documentation now has a few new extensions for additional features.
• Formatting of Python code now follows black.

In addition, the boilerplate is now being tracked/versioned via cruft. What this means is that when changes occur to the cookiecutter that this was based on (https://github.com/Ouranosinc/cookiecutter-pypackage), we can then apply those changes directly here to keep things up-to-date.

There were a few small bugs in the cookiecutter recipe that I missed/introduced in my last update, so I will likely be fixing those upstream and then fast-forwarding the changes here (perhaps in another PR, not urgent).

I also have plans to update the cookiecutter to use the more modern pyproject.toml standard (I've mentioned this point in meetings; For more information: PEP 517 and PEP 621, an example from xclim). This is a significant departure from the cookiecutter here (deletion of many files, moving configurations around, etc.), but again, upstream changes will be easily applied to xhydro when they're done. This task was already on my "to-do" list for other projects based on that cookiecutter.

Lastly, I've made a request to the admin of Hydrologie (not sure who that is) to allow for the Coveralls Pro webhook on this repository. Once that is approved, we will be able to monitor code coverage changes on every Pull Request.

All the best,

[sebastienlanglois]

Thanks @Zeitsperre for this amazing work in adapting the repo to modern conventions. We will benefit from this tremendously!

[sebastienlanglois]

Questions

• sphinx-pangeo-theme has been unmaintained for 4+ years and is not used in the docs, are we safe to remove it?
• I noticed some GitLab files mentioned. Is there a GitLab mirror of this repo?
• Requirements mirror xclim very closely; Am I free to remove most of these? We can add back in the relevant requirements as code is added to the repo.
• Are the documentation dependencies listed in environment.yml based on existing notebooks? If they are only anticipated to be useful, can we comment many of these out?

1. Yes, sphinx-pangeo-theme can be safely deleted as the theme used is "furo".
2. No there are none
3. Yes
4. Yes, the environment.yml is based on existing notebooks and "core" xhydro code that will soon be merged to the master branch.

[RondeauG]

LGTM! Thank you, great job!

[Zeitsperre]

@RondeauG

I need to perform one or two final adjustments (fixing a last bug I added, haha), but this will be ready to be merged early tomorrow.

The pyproject.toml changes will come in another PR sometime soon. No major rush.

[sebastienlanglois]

@Zeitsperre , just realised the CONTRIBUTING.rst has some TC-FF that should be replaced with hydrologie

[RondeauG]

@RondeauG

I need to perform one or two final adjustments (fixing a last bug I added, haha), but this will be ready to be merged early tomorrow.

The pyproject.toml changes will come in another PR sometime soon. No major rush.

Great! Feel free to merge when you think that it's good to go.