Add miniver to simplify development branch descriptions

[hmaarrfk]

Closes: #696

pip install -e . -vv
# You might only need to run this once I believe. we don't run it daily on our dev machines

In [1]: import pygfx

In [2]: pygfx.__version__
'0.1.18.post29+g9342016'

In [3]: from packaging.version import Version

In [4]: Version('0.1.18.post29+g9342016') > Version('0.1.18')
True

In [5]: assert Version('0.1.18.post29+g9342016') > Version('0.1.18')

In [6]: assert Version('0.1.18.post29+g9342016') < Version('0.1.19')

So I use this in my project and the github action that I use to upload the package to pypi will make the static version correctly.

You don't need to change the source when you create a new release. just tag then your CI will pickup the new version in the upload to pypi.

see: https://github.com/ramonaoptics/python-teensytoany
Xref: https://github.com/jbweston/miniver

[hmaarrfk]

I'm not sure what behavior you want from this version_info tuple. I don't have such constructs in my code.

I typically use

from packaging import Version

for all my comparisons.

[almarklein]

Let's do this:

Suggested change

	version_info = tuple(map(int, __version__.split(".")[:3]))
	version_info = tuple(int(v) if v.isnumeric() else v for v in __version__.split("."))

[hmaarrfk]

oh man, the CIs made this more difficult than I wanted to.

[hmaarrfk]

hmm, i've never used pyinstaller ...

[hmaarrfk]

This is actually the first time i read through the miniver code in earnest.

I understand how it is designed now, and I somewhat understand their design decisions of having 2 files.

But it is somewhat overly complicated.

It may be interesting to use https://github.com/proudust/gh-describe though this seems like getting more untrusted code in the repo.

[almarklein]

I'm not overly enthusiastic 😅 but this may also be because I don't understand the problem that it solves. Let's discuss in #696

[almarklein]

Let's do this:

Suggested change

	version_info = tuple(map(int, __version__.split(".")[:3]))
	version_info = tuple(int(v) if v.isnumeric() else v for v in __version__.split("."))

[almarklein]

IIUC this means that if someone obtains pygfx in another way than via a package manager or git repo, the version cannot be established.

[hmaarrfk]

Correct. There become some "edge cases" that you have to start taking into account when people "receive" the source code.

I just checked my project for example, the version downloaded from pypi burns things in due to the modifications to the setup.py but the archive from github would make it pretty difficult for people to use.

[Korijn]

My general feeling about this is that it's adding a ton of code, complexity and dependencies to solve a very small simple manual step... not too enthusiastic.

[hmaarrfk]

complexity and dependencies [...] not too enthusiastic.

Understood. This is a fair criticism.