Election-Tech-Initiative / Election-Tech-Initiative/electionguard-python

♻️ Migrate CLI print methods to single module

Open
#601 4 comments 0 reactions 4 assignees Claimed by @Alopezjr2002 View on GitHub
enhancement good first issue hacktoberfest help wanted
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

To improve the CLI and be a bit more pythonic, migrate the common click to echo to a more aptly named module. Ideally, this should contain the references to `click.echo` to a single module, but the closest to this is best.

### Possible Implementation

Create a `print_utils.py` file in the `electionguard_cli` to be used for all print functionality. These should all be methods and no classes should be necessary. This should allow the deletion of `e2estepbase.py`

Suggested items to migrate:
https://github.com/microsoft/electionguard-python/blob/03698c683ab35f608e35dc9b66217caa1d40f7eb/src/electionguard_cli/e2e_steps/input_retrieval_step.py#L42
https://github.com/microsoft/electionguard-python/blob/03698c683ab35f608e35dc9b66217caa1d40f7eb/src/electionguard_cli/e2e_steps/e2e_step_base.py#L14
https://github.com/microsoft/electionguard-python/blob/03698c683ab35f608e35dc9b66217caa1d40f7eb/src/electionguard_cli/e2e_steps/e2e_step_base.py#L19

https://github.com/microsoft/electionguard-python/blob/03698c683ab35f608e35dc9b66217caa1d40f7eb/src/electionguard_cli/e2e_steps/print_results_step.py#L13

### Anything else?

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.