Google GitGoogle Git
Sign in
apache/steve/refs/heads/trunk
commit
1081d378d612ee2943d90a76adfe7f2c62302c28
[log]
author
Greg Stein <gstein@gmail.com>
Tue Sep 08 08:03:57 2026 -0500
committer
Greg Stein <gstein@gmail.com>
Tue Sep 08 08:03:57 2026 -0500
tree
5d5a3dc3762a9a476fb4b108f7fa8f78efe434d2
parent
098dda094cfc543ca5cf7f557d7e86e59cb2dc43 [diff]
Document LoadData vote loading and migrate monitoring README to Markdown.

Record v3 vote-results.json as the tally source of truth, warn on
old-school txt/ini, and refuse v2 raw_board_votes.json. Point whatif
and the STV tests at the same loaders.

Co-authored-by: Grok <grok@x.ai>
4 files changed
tree: 5d5a3dc3762a9a476fb4b108f7fa8f78efe434d2
  1. .github/
  2. monitoring/
  3. site/
  4. v3/
  5. .asf.yaml
  6. .gitignore
  7. AGENTS.md
  8. doap_steve.rdf
  9. LICENSE
  10. NOTICE
  11. pelicanconf.yaml
  12. README.md
  13. steve_logo.psd
  14. stv9_template.txt
  15. whatif.py
  16. whatif.rb
README.md

Welcome to Apache Steve http://steve.apache.org/

Apache Steve is software to conduct a vote using the STV (Single Transferable Vote) and other voting algorithms. The tool grew out of the voting system used to elect the Apache Software Foundation Board of Directors.

Read more about STV at http://en.wikipedia.org/wiki/Single_transferable_vote

[!NOTE]

The v3 directory contains the current (ongoing) version of Steve. Read the v3/README.md file for more information about this version. Read the Getting Started Guide to set up a development environment for v3.

STV tally and what-if

Meek STV lives in monitoring/stv_tool.py. v3 tallies (steve.vtypes.stv) and the what-if CLI both call that module.

Load a vote file with LoadData.from_path (a file, not a directory):

InputBehavior
vote-results.json (v3 tally JSON)Source of truth. No warning.
raw_board_votes.txt (+ sibling board_nominations.ini)Old-school. Warns on stderr.
raw_board_votes.json (v2 export)Not a tally format. Warns and exits.
python3 monitoring/stv_tool.py path/to/vote-results.json
python3 monitoring/stv_tool.py -s 9 -v path/to/raw_board_votes.txt

What-if scenarios (seats, drop a candidate, runoff-only set) are whatif.py. The positional argv is fixed for whatif.rb:

python3 whatif.py [-v] VOTES_FILE [seats] [name ...]
python3 whatif.py VOTES_FILE -Lastname

Names may be first, last, or compacted full name (case-insensitive). A leading - on a name removes that candidate; otherwise only the named candidates run. Warnings for legacy files go to stderr so they do not break whatif.rb grepping of elected lines.

whatif.rb still consumes raw_board_votes.txt. Do not point it at v2 JSON. Prefer vote-results.json for new tallies.

See also monitoring/README.md.

Getting Started

Getting Started documentation can be found at: http://steve.apache.org/demo.html Otherwise, come to the #steve channel on the Slack workspace at the-asf.slack.com, and we'd be glad to help you.

Documentation

Documentation may be found at http://steve.apache.org/documentation.html

Contributions to the documentation are very welcome.

Mailing Lists

Discussion about Steve takes place on the following mailing lists:

dev@steve.apache.org    - About using Steve and developing Steve

Notification on all code changes are sent to the following mailing list:

commits@steve.apache.org

The mailing lists are open to anyone and publicly archived.

You can subscribe the mailing lists by sending a message to <LIST>-subscribe@steve.apache.org (for example dev-subscribe@steve.apache.org). To unsubscribe, send a message to <LIST>-unsubscribe@steve.apache.org. For more instructions, send a message to <LIST>-help@steve.apache.org.

Issue Tracker

If you encounter errors in Steve or want to suggest an improvement or a new feature, please visit the Steve issue tracker at https://github.com/apache/steve/issues