Skip to main content

A set of tools to work with preference data from the PrefLib.org website.

Project description

Preflibtools

PyPI Status Build badge codecov

Overview

The PrefLib-Tools is a set of Python tools developed to work with preference data from the PrefLib.org website.

This package provides input and output operations on PrefLib instances, together with some additional functionalities on the instances: Testing whether a Condorcet winner exists, whether the instance is single-peaked, etc...

We developed this package in the hope of making the use of PrefLib instances easy. This has been done in the same spirit as PrefLib: Providing tools for the community with the help of the community. If you want to contribute, feel free to create pull requests. If you have a question, a remark, or encounter a problem, please open an issue, create a pull request etc...

The full documentation of the package can be found there: https://preflib.github.io/preflibtools/.

If, for some reasons, you are looking for the older version of the PrefLib-Tools, it is still available in the GitHub repository Preflib-Tools-Old.

Installation

The installation is as easy as:

pip3 install preflibtools

Documentation

The complete documentation is available here.

GitHub Workflow

Publishing on PyPI

The pipeline between GitHub and PyPI is automatised. To push a new version do the following:

  • Update the pyproject.toml with the new version number.
  • Update the pabutools/__init__.py with the new version number.
  • On GitHub, create a new release tagged with the new version number (only admins can do that), on this page.
  • You're done, the new version of the package is automatically pushed to PyPI after the creation of a GitHub release.

Building the Docs

If the docs-source has been updated but the docs/ folder has not, you can build the docs via a GitHub action here: https://github.com/PrefLib/preflibtools/actions/workflows/docs.yml. Simply click "Run workflow" and the docs will be built and the built files will be pushed back to the server.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

preflibtools-2.0.33.tar.gz (61.7 kB view details)

Uploaded Source

Built Distribution

preflibtools-2.0.33-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

Details for the file preflibtools-2.0.33.tar.gz.

File metadata

  • Download URL: preflibtools-2.0.33.tar.gz
  • Upload date:
  • Size: 61.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for preflibtools-2.0.33.tar.gz
Algorithm Hash digest
SHA256 949cfc2857fe4fce8d402615281ac0c9ca68e6546d473527fa610698fb89951f
MD5 71965142d2074791db50a6a395624327
BLAKE2b-256 04cb5d6a8d41416b1d09b99fa05ed0f7f366ef35913d123e19e775e3a1763cf5

See more details on using hashes here.

File details

Details for the file preflibtools-2.0.33-py3-none-any.whl.

File metadata

  • Download URL: preflibtools-2.0.33-py3-none-any.whl
  • Upload date:
  • Size: 77.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for preflibtools-2.0.33-py3-none-any.whl
Algorithm Hash digest
SHA256 59c8a5c4d7de9a698f4cc349aad74ee121db6df44ed563bbc32d90ef54778d01
MD5 650fb85cf6da9d52b7298843d94c0ed5
BLAKE2b-256 06fa1881ba46d29d6da90c22eac60984a644882db6078f4d81bce36a507341df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page