Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjerdonek/open-rcv
Software for tallying ranked-choice voting elections like IRV and STV
https://github.com/cjerdonek/open-rcv
Last synced: about 1 month ago
JSON representation
Software for tallying ranked-choice voting elections like IRV and STV
- Host: GitHub
- URL: https://github.com/cjerdonek/open-rcv
- Owner: cjerdonek
- License: mit
- Created: 2014-09-28T06:14:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-01-12T15:37:10.000Z (about 10 years ago)
- Last Synced: 2024-11-30T00:33:12.944Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 2.06 MB
- Stars: 21
- Watchers: 9
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
OpenRCV
=======
[](https://travis-ci.org/cjerdonek/open-rcv)
[](https://coveralls.io/r/cjerdonek/open-rcv?branch=master)
[](http://docs.openrcv.org)
OpenRCV is an open source software project for tallying ranked-choice
voting elections like [instant runoff voting][IRV] and the
[single transferable vote][STV]. It also supports auditing, reporting,
and ballot file conversion. It can be used both as a command-line tool
or as a Python library.
OpenRCV is distributed for free on [PyPI][openrcv_pypi]. The project page
and source code are on [GitHub][openrcv_github]. Project documentation is
hosted on [Read the Docs][openrcv_docs].
It is licensed under a permissive open source license. See the
[License](#license) section for license details.
To report a bug or request a feature, visit the [issue tracker][openrcv_issues].
You can also contact the author listed [below](#author).
**Note (as of December 2014): This project is not yet usable, but we are
actively working on it.**
Features
--------
* Completely open and extensible.
* Tested against the publicly available test cases in the
[open-rcv-tests][open-rcv-tests] repository.
* Exposes both a command-line API and a Python API.
* Both APIs support neutral input and output text formats to allow
interoperability with other applications and programming languages.
For example, round-by-round results can be output as JSON to be--
* Passed to a custom "pretty" HTML renderer, or
* Checked numerically (i.e. independent of presentation) against
test data.
* Detailed logging while counting contests.
Requirements
------------
OpenRCV can be run using Python 3.4 (preferably 3.4.2 or later).
If you do not already have Python 3.4, you can download it
[here][python-download].
Installing
----------
$ pip install openrcv
If you see an error like the following in the logs, you can safely ignore it:
build/temp.macosx-10.9-x86_64-3.4/check_libyaml.c:2:10: fatal error: 'yaml.h' file not found
#include
^
1 error generated.
libyaml is not found or a compiler error: forcing --without-libyaml
Running It
----------
To count the ballots for one or more contests, pass the path to an OpenRCV
contests file:
$ rcv count data/sample.yaml
For detailed command-line help:
$ rcv --help
Testing It
----------
$ python -m unittest discover openrcv
Developing
----------
For information on contributing technically to the project or developing
applications that interact with OpenRCV, see the [Development][doc-develop]
page.
License
-------
This project is licensed under the permissive MIT license.
See the [LICENSE](LICENSE) file for the actual license wording.
History
-------
Chris Jerdonek began writing the code on September 27, 2014.
Author
------
Chris Jerdonek ()
[doc-develop]: docs/develop.md
[IRV]: http://en.wikipedia.org/wiki/Instant-runoff_voting
[openrcv_docs]: http://openrcv.readthedocs.org/
[openrcv_github]: https://github.com/cjerdonek/open-rcv
[openrcv_issues]: https://github.com/cjerdonek/open-rcv/issues
[openrcv_pypi]: https://pypi.python.org/pypi/OpenRCV
[open-rcv-tests]: https://github.com/cjerdonek/open-rcv-tests
[python-download]: https://www.python.org/downloads/
[STV]: http://en.wikipedia.org/wiki/Single_transferable_vote