OpenSourceEconomics / skillmodels

MIT License
11 stars 5 forks source link

Tags and skillmodels.__version__ #43

Closed janosg closed 1 week ago

janosg commented 4 years ago

Goal

We want to be able to find the skillmodels version by typing skillmodels.__version__ and checkout the corresponding source code via a tag.

Proposed implementation

Use zest.releaser to do the tagging and handling of the version number. I don't think it will completely replace our release.py because I didn't see any conda integration. My preferred solution would be to still have one python skript like release.py with a few additional command line arguments.

Since this will be relevant for respy, estimagic, gettsim and skillmodels, maybe someone else could look into it and then help me to implement it in skillmodels and estimagic.

@hmgaudecker, @tobiasraabe feel free to comment.

tobiasraabe commented 4 years ago

Some bigger projects (e.g. pandas) use https://github.com/warner/python-versioneer, but I do not understand what it exactly does by skimming the readme.

There is also https://github.com/c4urself/bump2version. I used the parent project a lot and it is probably the slimmest of all options.

No answer, but more options :)

hmgaudecker commented 4 years ago

Some bigger projects (e.g. pandas) use https://github.com/warner/python-versioneer, but I do not understand what it exactly does by skimming the readme.

Last commit to the repo 2 years ago. Have not tried looking through the 107 forks, but this does not seem like an active project.

Use zest.releaser to do the tagging and handling of the version

There is also https://github.com/c4urself/bump2version. I used the parent project a lot and it is probably the slimmest of all options.

I would be fine with any of the two -- both seem to be reasonably active and do what they are supposed to do. If @tobiasraabe has experience with bump[2]version, that probably is the most useful option given that we want to set it up and forget about it.

janosg commented 4 years ago

Yes, bump2version should be sufficient.

tobiasraabe commented 4 years ago

I am writing a maintenance guide for gettsim and document bump2version. Then, you can use it as well.

hmgaudecker commented 1 week ago

Outdated.