VoteKit is a Swiss army knife for computational social choice research.
Helpful links: Source Repository | Documentation | Issues & Feature Requests | Contributing | MGGG.org
Votekit can be installed through any standard package management tool:
pip install votekit
For more detailed instructions, please see the installation section of the VoteKit documentation.
This project is in active development in the mggg/VoteKit GitHub repository, where bug reports and feature requests, as well as contributions, are welcome.
Currently VoteKit uses poetry to manage the development environment. If you want to make a pull request, first pip install poetry to your computer. Then, within the Votekit directory and with a virtual environment activated, run poetry install This will install all of the development packages you might need. Before making a pull request, run the following:
poetry run pytest tests --runslowto check the test suite,poetry run black .to format your code,poetry run ruff check src teststo check the formatting, and thenpoetry run mypy srcto ensure that your typesetting is correct.
Then you can create your PR! Please do not make your PR against main.