Version Function

[FloydZ]

Description

• this PR adds a .version() function to the BaseEstimator class which should help identifying the exact version a user is using if its unclear.

Review process

from cryptographic_estimators.SDEstimator import SDEstimator

SDE = SDEstimator(n=100, k=50, w=10, include_quantum=True)
SDE.version()

this code should print something like:

Branch:  feat/version_function
Commit:  c82150ef0732d428c599c2ee2d2b9b54880e4ce0
Version: 2.0.0

Please test this function in different scenarios, like if the test file is not in the repo. If the repo is not installed, etc...

[Dioprz]

I can't provide quick testing now because I need to set up a Nix dev shell to install the package locally; but for now I would ask you to please change the docstrings to follow the Google style docstrings (or from our docs).

[Dioprz]

@FloydZ Circling back to this, the code looks good to me; but I have one concern:

Looking at how pip and pypi works during the installation process of a Python package, they don't typically include development files such as the .git/ directory. This means that, while this function could be useful for dev-users, it shouldn't be available for those who just want to consume the library through a pip install cryptographic_estimators command (unfortunately, I can't think of a way to test if that's true because the current package distributed by Pypi, of course, doesn't have this function).

So, if that consequence was by design, I would say: go ahead with the PR. But if that wasn't in the original plans, then I would suggest using another approach: setuptools_scm with its version_file configuration parameter. This tool essentially does the same thing we want: keep track of the library version using Git instead of some manual declaration. However, the version_file parameters also allows a normal but auto-managed python file with the version declared as a variable, so we could print or consume the version in any file of the repo without any low-level trick around .git/.

[FloydZ]

setuptools_scm

that looks much saner. Will have a look tomorrow

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud