Skip to content

Reorganize and refactor electionguardtest to electionguard-tools #401

Closed

Description

@keithrfung

Feature Request

Description

Rename
electionguardtest has increased in size gradually to include more items than just testing items.
tools or utils seems more accurate.

Reorganize
Screen Shot 2021-07-26 at 4 27 27 PM

/electionguard-tools
---- __init__.py
----/strategies
-------- __init__.py
-------- election.py
-------- elgamal.py
-------- group.py
----/factories
-------- __init__.py
--------ballot_factory.py
--------election_factory.py
----/helpers
-------- __init__.py
-------- sample_generator.py 
-------- key_ceremony_orchestrator.py <-- key_ceremony_helper
-------- tally_ceremony_orchestrator.py <--- decryption_helper
-------- tally_accumulate.py <--- tally

The inner folder init should all be sure to import and therefore export the inner files. For example, for init py in strategies


...
from .election import *
from .elgamal import *
from .group import *

This should assist with some import statements. The goal is to give more meaningful usings like
from electionguard-tools.strategies import elgamal_keypairs, elements_mod_q_no_zero

This will have an incredible amount of updates across the entire repository due to the imports but hopefully will help long term.

Activity

  1. changed the title [-]Reorganize and refactor `electionguardtest` to `electiongaurdtools`[/-] [+]Reorganize and refactor `electionguardtest` to `electionguardtools`[/+] on Jul 27, 2021
  2. soham4abc commented on Jul 31, 2021

    @soham4abc
    Contributor

    I am willing to work on this issue! If possible pls assign!

  3. removed this from the 🦖 Bowser Jr. v1.3.0 milestone on Aug 16, 2021
  4. changed the title [-]Reorganize and refactor `electionguardtest` to `electionguardtools`[/-] [+]Reorganize and refactor `electionguardtest` to `electionguard-tools`[/+] on Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions