Election-Tech-Initiative / Election-Tech-Initiative/electionguard-python
✨ Serialized classes should include an ElectionGuard version
- Dominant language
- Python
- Stars
- 168
- Forks
- 103
- PR merge metrics
- No merged PRs in 30d
Description
### Is there an existing issue for this?
- [X] I have searched the existing issues
### Suggestion
Serialized classes should include a version number that indicates what version is currently being used. Currently, the team is working towards `1.0` for the next release so the version would be 1.0.
This would overwrite the field that is currently on the manifest indicating the specification version. The expectation is a field on each section called `electionguard_version: "1.0"`
Possible names
`electionguard_version`
`eg_version`
`eg_ver`
`sdk_version`
### Possible Implementation
This could be done by adding a field to existing models but should likely be restricted to certain classes. The primary concern are those files in the Election Record exclusively.
Existing one to be changed.
https://github.com/microsoft/electionguard-python/blob/c59fddcd89f85619ba801d6c38b1ea7f08210951/src/electionguard/manifest.py#L583
### Anything else?
_No response_
Contributor guide
Assessment
This issue has not been assessed yet.