Version value rework and centralization

remyroy commented 1 month ago

Fixes #92

Changes

Centralize version in the __version__ variable in the __init__.py file.
Rework version in pyproject.toml to use the dynamic value in __version__.
Use the __version__ in settings.py file.
Adds a --version option to output the tool version and exit.

Types of changes

What types of changes does your code introduce?

[X] Bugfix (a non-breaking change that fixes an issue)
[ ] New feature (a non-breaking change that adds functionality)
[ ] Breaking change (a change that causes existing functionality not to work as expected)
[ ] Optimization
[X] Refactoring
[ ] Documentation update
[X] Build-related changes
[ ] Other: Description

Testing

Requires testing

[X] Yes
[ ] No

If yes, did you write tests?

[ ] Yes
[X] No

Notes on testing

Builds should be tested and tests suite run again.

Documentation

Requires documentation update

[ ] Yes
[X] No

Requires explanation in Release Notes

[ ] Yes
[X] No

Remarks

The idea is that __version__ will contain the single source of truth for the version of the project. As we perform a release, that file will be updated to include the new version. As we start the development for the next version, it should be updated again with a new version number that ends with .dev.

yorickdowne commented 1 month ago

Couldn't combine from non-existent path 'coverage*' - did this break coverage reporting?

remyroy commented 1 month ago

Let me see what's wrong with the coverage CI stuff.

remyroy commented 1 month ago

The coverage issue seems unrelated to this PR. Here is an example of another run where the coverage report doesn't work: https://github.com/eth-educators/ethstaker-deposit-cli/actions/runs/10659330561

remyroy commented 1 month ago

Coverage issue has been described in #137

yorickdowne commented 1 month ago

Do we still have the version in pyproject.toml as well?

remyroy commented 1 month ago

Do we still have the version in pyproject.toml as well?

No, it refers to the version number in the __version__ variable in the __init__.py file now.

github-actions[bot] commented 1 month ago

Test Coverage: Download HTML Report

Name                                                        Stmts   Miss  Cover
-------------------------------------------------------------------------------
ethstaker_deposit/__init__.py                                   1      0   100%
ethstaker_deposit/cli/__init__.py                               0      0   100%
ethstaker_deposit/cli/existing_mnemonic.py                     28      0   100%
ethstaker_deposit/cli/exit_transaction_keystore.py             39      2    95%
ethstaker_deposit/cli/exit_transaction_mnemonic.py             62      8    87%
ethstaker_deposit/cli/generate_bls_to_execution_change.py      66     15    77%
ethstaker_deposit/cli/generate_keys.py                         43      3    93%
ethstaker_deposit/cli/new_mnemonic.py                          26      0   100%
ethstaker_deposit/cli/partial_deposit.py                       61      5    92%
ethstaker_deposit/credentials.py                              197     68    65%
ethstaker_deposit/deposit.py                                   56     10    82%
ethstaker_deposit/exceptions.py                                 2      0   100%
ethstaker_deposit/key_handling/__init__.py                      0      0   100%
ethstaker_deposit/key_handling/key_derivation/__init__.py       0      0   100%
ethstaker_deposit/key_handling/key_derivation/mnemonic.py      90      7    92%
ethstaker_deposit/key_handling/key_derivation/path.py          17      1    94%
ethstaker_deposit/key_handling/key_derivation/tree.py          36      0   100%
ethstaker_deposit/key_handling/keystore.py                    100      0   100%
ethstaker_deposit/settings.py                                  23      1    96%
ethstaker_deposit/utils/__init__.py                             0      0   100%
ethstaker_deposit/utils/ascii_art.py                            2      0   100%
ethstaker_deposit/utils/click.py                               70      3    96%
ethstaker_deposit/utils/config.py                               3      0   100%
ethstaker_deposit/utils/constants.py                           27      0   100%
ethstaker_deposit/utils/crypto.py                              29      1    97%
ethstaker_deposit/utils/deposit.py                              9      0   100%
ethstaker_deposit/utils/exit_transaction.py                    24      0   100%
ethstaker_deposit/utils/file_handling.py                        8      0   100%
ethstaker_deposit/utils/intl.py                                54      3    94%
ethstaker_deposit/utils/ssz.py                                 50      6    88%
ethstaker_deposit/utils/validation.py                         204     51    75%
-------------------------------------------------------------------------------
TOTAL                                                        1327    184    86%

remyroy commented 1 month ago

This PR should be good for review again with the fix from #139

eth-educators / ethstaker-deposit-cli