pytroll / pytroll-aapp-runner

Pytroll runner for AAPP
http://pytroll-aapp-runner.readthedocs.io/en/develop/
GNU General Public License v3.0
1 stars 8 forks source link

Use setuptools scm versioning #16

Closed adybbroe closed 3 years ago

adybbroe commented 3 years ago

Use setuptools_scm to manage package versions in SCM (git) metadata instead of declaring them as the version argument or in a git managed file.

ghost commented 3 years ago

Congratulations :tada:. DeepCode analyzed your code in 2.911 seconds and we found no issues. Enjoy a moment of no bugs :sunny:.

👉 View analysis in DeepCode’s Dashboard | Configure the bot

adybbroe commented 3 years ago

@mraspaud or @gerritholl Do one of you mind have a quick look at this one?

adybbroe commented 3 years ago

See pytroll/satpy#1512

I would vote for writing to a aapp_runner/version.py file instead of going the pkg_resources route. There are performance issues when depending on pkg_resources and it is a big problem when done on import (like this would be.

Like so @djhoese ? Thanks!

adybbroe commented 3 years ago

Hmm, so this would require me to add aapp_runner/version.py to the repo, and at every new version this file is updated. Have I understood you right @djhoese ?

djhoese commented 3 years ago

@adybbroe No! You add version.py to the .gitignore and never commit it. It will be generated when the package is installed.

adybbroe commented 3 years ago

Looks good. I think the only concern I have is that for backwards compatibility with older versions of pip I think you could add the setuptools_scm options to the setup.py too. But given the smaller audience for this package maybe that doesn't matter (pyproject.toml should be good enough).

Yeah, thanks, I saw that comment also on the setuptools_scm pages, but I thought as you said that with the (still) rather small audience here, it is okay.