Election-Tech-Initiative / electionguard-python

A python module implementing the ElectionGuard specification. This implementation can be used to conduct End-to-End Verifiable Elections as well as privacy-enhanced risk-limiting audits.
https://www.electionguard.vote/
MIT License
162 stars 97 forks source link

♻️ Migrate ElectionBuilder #579

Closed keithrfung closed 2 years ago

keithrfung commented 2 years ago

Is there an existing issue for this?

Suggestion

The ElectionBuilder is a stateful factory to create an election. This should be migrated to electionguard_tools under helpers. The existing references to ElectionBuilder should be updated. Be sure to make sure to auto-lint to have the init's updated.

Location of ElectionBuilder https://github.com/microsoft/electionguard-python/blob/8aa589c9744bdf52e1e2659e2f83c255ffc65441/src/electionguard/election_builder.py#L13-L18

Possible Implementation

No response

Anything else?

No response

pratik9315 commented 2 years ago

Can i work on this if its alright?

keithrfung commented 2 years ago

@pratik2315 It's all yours.

pratik9315 commented 2 years ago

hey @keithrfung ! I have done the changes and put the comment in electionguard_tools/helpers/init.py. I've put the comment in init.py file. pls suggest any changes if required. thanks.

keithrfung commented 2 years ago

@pratik2315 The concern is the entire class needs to be relocated not just the comment (docstring).

Tasks

pratik9315 commented 2 years ago

Oh my bad, I should've asked more questions, I'll make the change and migrate the entire class under helpers.

pratik9315 commented 2 years ago

Hey can you help me out im recieving some errors while running the tests and im unable to figure out exactly what are they

Screenshot (37)

keithrfung commented 2 years ago

You may have to alter the file paths for windows. We recommend running this in WSL2.