infoaed / pseudovote Goto Github PK

The minimal documentation should probably explain:

• The basic rationale, scope and uses for the project;
• Using the example web service (explain the configuration properties);
• Cautions/instructions for running in practise (real elections, hacking contests etc);
• Running your own instance and modifying the code.

This should be more than enough for the code release... Wiki, readme or something else?

Currently the ballots for poll types of multiple, ordered multiple and single are formatted like:

1) rumunculus335: 1. Charles De Goal, Mookie Blaylock; 2. 1) Mookie Blaylock, 2) Einar Stray Orchestra, 3) Charles De Goal; 3. Mookie Blaylock

Maybe there are improvements to the format, but there should be some basic tools to download the bulletin board in different formats (plain text, CSV, JSON) and count votes fitting the format requirements (although this doesn't need to be authoritative tally).

Probably having the code as modular as possible from the beginning makes sense, so there can be different database backends, no database backends for example for single board computers, cryptography modules for different voting mechanisms, rate limit and/or attack resistance modules etc. Need to look up some best practice examples I suppose.

IIUIC the pseudonyms need to be secret. Even though it is suggested that they should be generated separately, probably should use strong randomness to generate them in the demo instance:

random_words = random.sample(word_list, voter_count)

Quite possibly wants to use secrets module: https://docs.python.org/3/library/secrets.html

Presumptive choice of AGPL stemmed from the public nature of the project. This might be suitable for actually running systems for transparency reasons but not so much for experimenting with the code. Probably opting for Apache, MIT or similar makes more sense. Are there any middle grounds, (L)GPL or some of the less widespread licenses, that would allow separate licenses for actually running systems?