Created a clean virtual environment and installed gsb (version 0.0.2) via pip along with mypy.
Created the following python file, which has numerous type issues:
from gsb import history
x: tuple[str] = history.get_history(".", since="today")
Ran mypy on the python file and got back the following response:
hint_test.py:1: error: Skipping analyzing "gsb": module is installed, but missing library stubs or py.typed marker [import]
hint_test.py:1: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 1 error in 1 file (checked 1 source file)
Navigated to my project repo and ran pip install -e . (gsb -V now replies with "gsb, version 0.0.2+24.g4a1a6a6")
Ran mypy again. Got the response:
hint_test.py:2: error: Incompatible types in assignment (expression has type "list[_Revision]", variable has type "tuple[str]") [assignment]
hint_test.py:2: error: Argument 1 to "get_history" has incompatible type "str"; expected "Path" [arg-type]
hint_test.py:2: error: Argument "since" to "get_history" has incompatible type "str"; expected "date" [arg-type]
Found 3 errors in 1 file (checked 1 source file)
[x] I have run mkdocs serve locally and ensured that all API docs and
changes I have made to the static pages are rendering correctly, with all links
working
[x] All tech debt concerns have been resolved, documented as issues, or otherwise
accepted
Summary
Implements #35
List of Changes
Tech Debt and Other Concerns
Validation Performed
gsb
(version 0.0.2) via pip along withmypy
.mypy
on the python file and got back the following response:pip install -e .
(gsb -V
now replies with "gsb, version 0.0.2+24.g4a1a6a6")mypy
again. Got the response:PR Type
release
)Checklist:
mkdocs serve
locally and ensured that all API docs and changes I have made to the static pages are rendering correctly, with all links working