Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ Migrate CLI print methods to single module #601

Open
1 task done
keithrfung opened this issue Apr 19, 2022 · 4 comments · May be fixed by #716
Open
1 task done

♻️ Migrate CLI print methods to single module #601

keithrfung opened this issue Apr 19, 2022 · 4 comments · May be fixed by #716
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Issues for the Hacktoberfest help wanted Extra attention is needed

Comments

@keithrfung
Copy link
Collaborator

Is there an existing issue for this?

  • 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

@keithrfung keithrfung added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest Issues for the Hacktoberfest labels Apr 19, 2022
@keithrfung keithrfung transferred this issue from Election-Tech-Initiative/electionguard Apr 19, 2022
@keithrfung keithrfung self-assigned this Jun 27, 2022
@keithrfung keithrfung removed their assignment Jun 30, 2022
@Alopezjr2002
Copy link

Hello my name is Antonio and I would like to contribute to this issue along with my two peers, Pedro and Justice.

@CodingForFun-coder
Copy link

Hey, I'm Pedro Rangel, and I will be part of the team.

@JKnight777
Copy link

Hello my name is Justice and I would like to help contribute to this issue along with Antonio, and Pedro.

@rc-ms
Copy link
Contributor

rc-ms commented Jul 6, 2022

welcome @JKnight777 @CodingForFun-coder and @Alopezjr2002 welcome aboard! Please have at it and use this issue for any questions and comments. I'll also send you invites to the Democracy Forward slack

Alopezjr2002 added a commit to Alopezjr2002/electionguard-python that referenced this issue Jul 21, 2022
Alopezjr2002 added a commit to Alopezjr2002/electionguard-python that referenced this issue Jul 22, 2022
Alopezjr2002 added a commit to Alopezjr2002/electionguard-python that referenced this issue Jul 22, 2022
Alopezjr2002 added a commit to Alopezjr2002/electionguard-python that referenced this issue Jul 22, 2022
Alopezjr2002 added a commit to Alopezjr2002/electionguard-python that referenced this issue Jul 23, 2022
@JKnight777 JKnight777 linked a pull request Jul 23, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Issues for the Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants