votingsys 0.0.1a0

Library for preference (or ranked) voting

votingsys

Overview

A Python library that provides implementations of various voting systems. This library is designed to simulate the outcomes of elections using multiple voting methods. It enables users to compare how different voting systems may influence election results based on the same set of voter preferences or inputs.

• Motivation
• Documentation
• Installation
• Contributing
• API stability
• License

Motivation

Documentation

• latest (stable): documentation from the latest stable release.
• main (unstable): documentation associated to the main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing parts.

Installation

We highly recommend installing a virtual environment. votingsys can be installed from pip using the following command:

pip install votingsys

To make the package as slim as possible, only the minimal packages required to use votingsys are installed. To include all the dependencies, you can use the following command:

pip install votingsys[all]

Please check the get started page to see how to install only some specific dependencies or other alternatives to install the library. The following is the corresponding votingsys versions and tested dependencies.

votingsys	numpy	polars	python
main	>=2.0,<3.0	>=1.0,<2.0	>=3.9,<3.14

^* indicates an optional dependency

older versions

Contributing

Please check the instructions in CONTRIBUTING.md.

Suggestions and Communication

Everyone is welcome to contribute to the community. If you have any questions or suggestions, you can submit Github Issues. We will reply to you as soon as possible. Thank you very much.

API stability

:warning: While votingsys is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading votingsys to a new version will possibly break any code that was using the old version of votingsys.

License

votingsys is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.