Implementation of all the tools necessary to explore and analyse participatory budgeting elections
Pabutools: PB as easy as ABC
The pabutools are a complete set of tools work with participatory budgeting instances.
Participatory budgeting (PB) is a democratic tool used to allocate a given amount of money to a collection of projects based on a group of individuals' preferences over the projects. It has been invented in Brazil in the late 80's and is now a widely implemented. See the Wikipedia page for more details.
In this library, we provide tools that
- handle PB instances of different kinds,
- compute voting rules to determine the outcome of the elections,
- analyse outcomes, and
- provide full support for the instances taken from the pabulib library of PB data.
The package can be installed from PyPI using:
pip3 install pabutools
The complete documentation is available here. It includes
- installation instructions,
- a short guide for a quick start,
- a complete guide for more advanced usage, and
- a reference guide to get all the details.
We are more than happy to receive help with the development of the package. If you want to contribute, here are some elements to take into account.
First, install the development dependencies by running the following command:
pip install -e ".[dev]"
You can run the unit tests with the following:
python -m unittest
To generate the doc, first move inside the
docs-source folder and run the following:
make clean make html
This will generate the documentation locally (in the folder
docs-source/build). If you want the documentation
to also be updated when pushing, run:
After having pushed, the documentation will automatically be updated.
Note that a large part of the documentation is done by hand (to ensure proper display and correct ordering).
This means that if you create new class of functions that should appear in the documentation, you may have
to add they yourself using to autodoc directives (take inspiration from the files in
If you want to help, check the
todos.txt file, several todos are described there.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pabutools-1.1.3-py3-none-any.whl