Package: wheatley
WheatleyA bot forRinging Roomthat can fill in any set of bells to increase the
scope of potential practices, designed to be a'ninja helper with no ego'.If you just want to use Wheatley for normal ringing without caring about how it works, then check
out how to use Wheatley directlyinside Ringing Room- no
installation required, just a flick of a switch.  If you want more control than the Ringing Room
interface provides or are interested in how Wheatley works, then this is the place to go.  This
repository contains Wheatley's source code, and documentation of the 'classic' command line version.ContributingContributions are very welcome!  To keep this readme short, all contribution info is inCONTRIBUTING.md.  If you have any issues/suggestions, eithermake an
issue, or drop me a messageon
Facebook.Quickstart(This quickstart refers to the command-line Wheatley, not the integrated version).  Also, if
anything here doesn't work or is confusing, please let us know.  For help with what parameters
Wheatley has and what they do, runwheatley --help.Step 1: Install PythonInstallation is very platform specific, so I've split this by OS.WindowsDownload the latest version of Python frompython.org- the first link should be to the latest
build of Python 3. At the bottom of the linked page is a list of downloads - most likely you need
"Windows installer (64-bit)" (the recommended option).When the file has downloaded, run it.  Before starting the installation,tick the "Add to
PATH" option(this will make your life way easier later on).  Start the install, and then wait
for it to complete.In order to run Wheatley, you'll need to open a 'command prompt'.  To do this, press the START
button in Windows, type 'cmd' then click on theCommand Promptapplication.  This creates a
black window, into which you can type and then run commands (including Wheatley).Test Python by typingpy --versionand then pressing enter.  If all is well, this will print a
version string - otherwise something has gone wrong.MacOSInstructions should behere.LinuxAlmost all Linux distros come with Python installed, so this step can probably be skipped.Step 2: Install WheatleyOnce Python is installed, installing Wheatley should be done through Python's package managerpip.
The exact commands vary from system to system (and I can't keep track of them all), but one of the
following should work:# Should work on Windowspy-mpipinstall--upgradewheatley# Should work on MacOS and Linuxpython3-mpipinstall--upgradewheatleyStep 3: Run WheatleyNOTE:The name of the Wheatley command will sometimes vary.  If you're getting errors like
'wheatley not found', then try replacing thewheatleyprefix withpy -m wheatley(Windows) orpython3 -m wheatley(MacOS/Linux).  So therefore, a complete command would look like:py -m wheatley [ID NUMBER] --method "Plain Bob Major"
# or 
python3 -m wheatley [ID NUMBER] --method "Plain Bob Major"ExamplesJoin aringingroom.comtower with (9 digit) ID[ID NUMBER]and ring Plain Bob Major (tower
bell style – wait forGoandThat's all):wheatley[IDNUMBER]--method"Plain Bob Major"Ring 'up, down and in' rather than waiting for 'go':wheatley[IDNUMBER]--use-up-down-in--method[METHODTITLE]# orwheatley[IDNUMBER]-u--method[METHODTITLE]Ring full handbell style, i.e. 'up, down and in' and standing at rounds (-His
equivalent to-us):wheatley[IDNUMBER]--use-up-down-in--stop-at-rounds--method[METHODTITLE]# orwheatley[IDNUMBER]-us--method[METHODTITLE]# orwheatley[IDNUMBER]-H--method[METHODTITLE]Join a server other thanringingroom.com:wheatley[IDNUMBER]--urlotherwebsite.com--method[METHODTITLE]Ring rows and make calls taken from a composition fromcomplib.org, in this
casehttps://complib.org/composition/65034:wheatley[IDNUMBER]--comp65034Ring rows but don't send the calls to Ringing Room taken from a composition fromcomplib.org, in this
casehttps://complib.org/composition/65034:wheatley[IDNUMBER]--comp65034--no-callsRing compositions withsubstituted methodsby copying the id and query string or full url fromcomplib.org):wheatley[IDNUMBER]--comp68549?substitutedmethodid=28000# orwheatley[IDNUMBER]--comphttps://complib.org/composition/68549?substitutedmethodid=28000Ringprivatecompositions by copying the share link fromcomplib.org:wheatley[IDNUMBER]--comp51155?accessKey=9e1fcd2b11435552cf236be93c7ff73058870995# orwheatley[IDNUMBER]--comphttps://complib.org/composition/51155?accessKey=9e1fcd2b11435552cf236be93c7ff73058870995Combine method substitution and private compositionwheatley[IDNUMBER]--comp51155?substitutedmethodid=27600&accessKey=9e1fcd2b11435552cf236be93c7ff73058870995Ring rows specified by place notation, in this case Plain Bob Minor:wheatley[IDNUMBER]--place-notation6:x16x16x16,12Ring at a peal speed of 3 hours 30 minutes (i.e. quite slowly):wheatley[IDNUMBER]--method[METHODTITLE]--peal-speed3h30# orwheatley[IDNUMBER]--method[METHODTITLE]-S3h30Make Wheatley push on with the rhythm rather than waiting for people to ring.wheatley[IDNUMBER]--method[METHODTITLE]--keep-going# orwheatley[IDNUMBER]--method[METHODTITLE]-kCompletely ignore other users' changes in rhythm (useful if he's ringing most of
the bells and you don't want him to randomly change speed when you make mistakes):wheatley[IDNUMBER]--method[METHODTITLE]--inertia1.0# orwheatley[IDNUMBER]--method[METHODTITLE]-I1.0Start from a different rowwheatley[IDNUMBER]--method[METHODTITLE]--start-row13572468