Update cookiecutter, restructure library - Githubissues

hydrologie / xdatasets

https://xdatasets.readthedocs.io/

MIT License

2 stars 0 forks source link

Update cookiecutter, restructure library #126

Closed Zeitsperre closed 3 months ago

Zeitsperre commented 4 months ago

Pull Request Checklist:

[ ] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #xyz
[ ] (If applicable) Documentation has been added / updated (for bug fixes / features).
[ ] (If applicable) Tests have been added.
[x] CHANGES.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

Updates the cookiecutter to the latest commit.
The ruff linter has been adjusted to render the flake8-alphabetize dependency redundant (and removed).
Several noqa and fixme statements have been added to pass additional linting checks for now.

Does this PR introduce a breaking change?

Yes.

The structure of the package is slightly modified from a flat layout to a src layout. (https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/)
CHANGES.rst is now CHANGELOG.rst. (https://keepachangelog.com/en/1.1.0/#frequently-asked-questions)
Bumping a release version will trigger changes in the CHANGELOG.rst file. (https://github.com/Ouranosinc/cookiecutter-pypackage/issues/41)

Other information:

~This does not yet integrate changes from https://github.com/Ouranosinc/cookiecutter-pypackage/pull/50 (but it should before merging)~

We should perform a release after this and then see about proposing the package to conda-forge!