python-voting/README.md
Brian Wiborg 9bb0d83b02
📝 Add README
2023-04-02 16:48:27 +02:00

31 lines
586 B
Markdown

# Python-Voting
A Python 3.11 module for votings on the c-base space-station.
## Usage
```python
from voting.voting import QuorumKind, Quorum, Vote, Voting
# initializing a new voting
voting = Voting(
title="TITLE",
quorum=Quorum(),
#quorum=Quorum(kind=QuorumKind.ABSOLUTE, value=42),
#quorum=Quorum(kind=QuorumKind.PERCENT, value=42.0),
voters=['alice', 'bob'],
)
# starting the voting
voting.start()
# placing a vote
voting.vote('alice', Vote.NO)
# overwrite an existing vote
voting.vote('alice', Vote.YES)
# obtaining the result
res = voting.result()
print(res)
```