Metadata-Version: 2.1
Name: whalrus
Version: 0.4.6
Summary: Which Alternative Represents Us, a package for voting rules
Home-page: https://github.com/francois-durand/whalrus
Author: François Durand
Author-email: fradurand@gmail.com
License: GNU General Public License v3
Keywords: whalrus
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: Click (>=6.0)
Requires-Dist: numpy
Requires-Dist: toolz
Requires-Dist: pyparsing

=======
Whalrus
=======


.. image:: https://img.shields.io/pypi/v/whalrus.svg
        :target: https://pypi.python.org/pypi/whalrus
        :alt: PyPI Status

.. image:: https://github.com/francois-durand/whalrus/workflows/build/badge.svg?branch=master
        :target: https://github.com/francois-durand/whalrus/actions?query=workflow%3Abuild
        :alt: Build Status

.. image:: https://github.com/francois-durand/whalrus/workflows/docs/badge.svg?branch=master
        :target: https://github.com/francois-durand/whalrus/actions?query=workflow%3Adocs
        :alt: Documentation Status

.. image:: https://codecov.io/gh/francois-durand/whalrus/branch/master/graphs/badge.svg
        :target: https://codecov.io/gh/francois-durand/whalrus/branch/master/graphs
        :alt: Code Coverage



Which Alternative Represents Us, a package for voting rules


* Free software: GNU General Public License v3
* Documentation: https://francois-durand.github.io/whalrus/.

--------
Features
--------

* TODO

-------
Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

We use the checklist provided by `Package Helper 2`_.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _`Package Helper 2`: https://package-helper-2.readthedocs.io/


=======
History
=======

-----------------------------------------
0.4.6 (2020-12-01): Improve test coverage
-----------------------------------------

* Reach 100% of test coverage. Cf. https://codecov.io/gh/francois-durand/whalrus.
* Convert documentation to Numpy style. The documentation is not changed much in html format, but is more readable in
  plain text.
* Remove hash function for ``BallotOneName`` and ``BallotOrder``. It had a bug, and fixing it would have implied to
  change all sets of candidates to frozen sets. Since this function is non-essential, we decided to remove it instead.
* Fix bug in ``MatrixWeightedMajority`` when using the option ``ordered_vs_absent`` or ``absent_vs_ordered``.
* Fix bug in ``Rule.trailer_`` when there is only one candidate in the election.

---------------------------------------------------
0.4.5 (2020-11-26): Fix Missing Files in Deployment
---------------------------------------------------

* Files from some sub-packages, such as ``scale``, were missing. This release fixes that bug.

---------------------------------------
0.4.4 (2020-11-26): Fix PyPI deployment
---------------------------------------

* Fix PyPI deployment.

----------------------------------
0.4.3 (2020-11-26): GitHub Actions
----------------------------------

* This patch concerns Whalrus' developpers only. To develop and maintain the package, it uses GitHub actions
  instead of additional services such as Travis-CI and ReadTheDocs.
* Use Codecov.
* Prepare support for Numpy documentation style (not used yet).
* Prepare support for notebooks in documentation (not used yet).

-------------------------------
0.4.2 (2019-08-22): Speeding Up
-------------------------------

* Minor patch to speed up the computation of the winner in some cases.

--------------------------------
0.4.1 (2019-04-01): Tie-breaking
--------------------------------

* Fix a bug related to random tie-break.
* In the arguments of class ``RuleRankedPairs``, the tie-break can be given directly, instead of having to go through
  the argument ``matrix``.

---------------------------
0.4.0 (2019-03-29): Schulze
---------------------------

* Implement Schulze rule.

--------------------------------
0.3.0 (2019-03-29): Ranked Pairs
--------------------------------

* Implement Ranked Pairs rule.

---------------------------------------------
0.2.1 (2019-03-28): Optimize argument passing
---------------------------------------------

* Optimize argument passing between child classes, their parent classes and their ``__call__`` function.

------------------------------------------
0.2.0 (2019-03-21): Classic voting systems
------------------------------------------

* First "real" release, where most classic voting systems are implemented.

---------------------------------
0.1.0 (2018-03-13): First release
---------------------------------

* First release on PyPI.


