search

pangaea-data-publisher / pangaeapy

PANGAEA Python Client
https://www.pangaea.de/
GNU General Public License v3.0
29 stars 18 forks source link

Add a changelog #51

Closed fspreck-indiscale closed 11 months ago

fspreck-indiscale commented 1 year ago

This package is missing a changelog telling users what parts of the API were added, changed, removed, deprecated, fixed...

A good idea would be to follow https://keepachangelog.com/en/1.1.0/ and use semantic versioning.

fspreck-indiscale commented 11 months ago

I just experienced again, how helpful this could be: somewhere between 1.0.16 and 1.0.17 the former child/parent datasets were renamed to datasets/collections, also changing the names of e.g., PanDataSet.isParent to PanDataSet.isCollection, thus breaking the API. These kind of changes should be noted in a changelog, and ideally a breaking API change should be denoted more clearly in the package version (cf. samantic versioning, where a breaking API change would cause an increase of the major version. I.e., pangaeapy 1.0.17 would be pangaeapy 2.0.0).

fspreck-indiscale commented 11 months ago

If you're interested @huberrob, I could prepare a PR adding the general structure for this; also for #50.

huberrob commented 11 months ago

sorry for the inconvenience, shall I bring back the old variables so you can keep your workflow unchanged? PR is welcome, If you do so please also take into account the effect on pypi packages etc.. I promise to add some changelog in the future at least for new releases.

fspreck-indiscale commented 11 months ago

No worries! I adapted my scripts to 1.0.17, but re-introducing the old variables (maybe with a DeprecationWarning) could maybe help other users who stumble upon this, so probably a good idea.

Sure, I'll try not to break anything. ;-)

fspreck-indiscale commented 11 months ago

I started a PR for this and #50. The changes should make everything adhere to the PYPA setup tools specifications and should not have any effect (except for adding the README.md as description) on the PyPi package.

fspreck-indiscale commented 11 months ago

Completed with merge of #55