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

How to organize the project / requirements / folders/ libraries #25

Open
masiarek opened this issue Jul 4, 2023 · 1 comment
Open

Comments

@masiarek
Copy link
Collaborator

masiarek commented Jul 4, 2023

Questions

Should we have two versions of starpy tabulation software:
- "basic" - with dependencies (numpy, pytest, etc)  <-- this is where we are
- "complex" - without dependencies - see example -->  https://github.com/larryhastings/starvote

"Basic" 
Should be as straight forward as possible - even for users without programming skills - just install python and run the program.
Allow user to play with STAR Voting method.
PROS:
- simple (avoid dependencies version control, no need to install dependencies)
CONS:
- missing useful libraries/dependencies that advanced user / programmer would be happy to use

"Complex" 
PROS:
- all bells and whistles
- test cases 
- expected test results
CONS:
- user must install dependencies

"Hybrid approach"
Have one library - but installation process is asking user what to install - Basic or Complex.

"As-Is"

We are using a "complex" approach.
starpy:
- Allocated_Score.py
- STAR.py
tests:
- test_STAR_single_winner.py
- test_STAR_multi_winner_allocated_score.py
- test_STAR_single_winner.py

"Should-Be":

Do we want to incorporate the "basic" simple approach (see https://github.com/larryhastings/starvote) into our library?
How to organize this?
Follow "Hybrid" approach?

@mikefranze
Copy link
Contributor

We shouldn't create two versions that we have to maintain. If we end up creating a "simple" version with no dependencies we should just migrate to that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants