feat: [VRD-818] Implement BuildScan class

[liuverta]

Impact and Context

Now we have a user-facing class to represent the results of a model build scan!

Risks and Area of Effect

None; entirely new functionality, covered by tests.

Testing

• Unit test
• Deployed to dev env
• Other (explain)

In Python 3.10:

% pytest unit_tests/deployment/test_build_scan.py 
==================================================== test session starts ====================================================
platform darwin -- Python 3.10.6, pytest-7.2.1, pluggy-1.0.0
rootdir: /Users/miliu/Documents/modeldb/client/verta/tests, configfile: pytest.ini
plugins: forked-1.4.0, xdist-3.1.0, typeguard-2.13.3, hypothesis-6.67.1
collected 1 item                                                                                                            

unit_tests/deployment/test_build_scan.py .                                                                            [100%]

===================================================== 1 passed in 0.43s =====================================================

Reverting

• Contains Migration - Do Not Revert

Revert this PR.

[liuverta]

Enum variants are technically class members, and there isn't a clean way to attach meaningful docstrings to them, so we have to clumsily tell our documentation, "If a class's name ends with Enum, go ahead and render its undocumented members" as a bit of a hack.

[ewagner-verta]

This bit gives you the OPTION = 'option' style listing of all the possible options at the end of the doc string I assume?

[liuverta]

Yes

[liuverta]

[liuverta]

[liuverta]

[liuverta]

Note Build.get_scan() isn't hyperlinked, because it isn't implemented until #3758.

[ewagner-verta]

The only minor concern I have is the use of the term "status" , as it could be a bit confusing and potentially be conflated with "progress". (Checking the progress of a scan could arguably mean the same thing as checking the status of a scan). I wonder if something like ScanResultEnum / Buildscan.result might make it more explicit that this object represents the outcome/result of a completed scan.

[liuverta]

I've addressed @ewagner-verta's feedback by replacing any references to a build scan's "status" with "result".

Tests still pass, screenshots of documentation have been updated, and a cmd+F of this PR's diff for "status" confirms that the word is no longer being used in the user-facing client API.