Internal Code Review

[hardbyte]

@RacingTadpole has carried out an independent code review of clkhash.

Summary

No major issues identified. The code looks well structured. The two most important issues
would be clearing up the python version compatibility, and checking that the type errors are
not pointing to any uncovered edge cases. An architectural suggestion would be to remove
the dependence on the tqdm progress bar from clk.py, and move it to cli.py.

The 3 page report is available - Clkhash code review.pdf

This issue will track the individual changes to address the identified problems.

Aha! Link: https://csiro.aha.io/features/ANONLINK-41

[hardbyte]

Open Issues:

• out of date cryptography requirements - Update cryptography package and pin test dependencies #95
• adding test requirements - Update cryptography package and pin test dependencies #95
• automated dependency vulnerability detection - Automatically check for vulnerabilities in dependencies #97
• attribute names dataset - Attribute the first/last name dataset source #98
• consider applying black to avoid some minor formatting issues - Code formatting issues - automate? #99
• creating attributes outside of __init__ - Creating attributes outside of __init__ #100
• unused imports - Search for and remove unused imports #101
• out of date docstrings - Check docstrings are up to date #102
• test CLI properly - Command Line Tool not fully unit tested #103
• progress bars shouldn't be part of the python library only part of the CLI - Progress printing should be cli specific #104
• document our use of mypy - Clearly state how we expect to run mypy #105
• resolve python version ambiguity - Clearly state which versions of python are supported #106
• test clk.py properly - clk.py not well tested #108