This is some very simple code to generate textual rulesets. Currently, it is implemented in Python, but previous Rulekeepors have written very similar code in Haskell and Ruby.
- If desired, create a Python virtual environment. This page does a very good job explaining how to do so.
- Once you are inside your virtual environment, run
pip install -r requirements.txtto get all dependencies (currently only PyYaml).
That's all there is to it.
Here is a quick summary of what each of the folders in this repository do:
config: There are several files here that control how the rule text is generated.proposals: Every proposal that is relevant to the current ruleset is stored here in order to generate rule change annotations.rulekeep: This houses code that I didn't want to include in gen.py because it would make it very long.ruleset: Scores of rules that have been or are in the ruleset, along with their text and a changelist.
gen.py generates rulesets. If you just run python gen.py, however, you will recieve an error. That's because there are a few arguments you need to know.
The first argument is the path of the directory containing the data (i.e. the config, proposals, and rules directories).
The next argument is the mode to be used when generating the output. It can have one or more of the following letters in it:
s: generate a Short Logical Rulesetf: generate a Full Logical Ruleset
You'll notice a folder called "meta" is created on the first run. Data is stored here to make generating a ruleset take less time and be less processor-intensive. It does this by storing each rule's generated text in a file. On successive runs, it will check to see if the file's contents are the same as before, and it will only generate new rule text if they are not.
If you want to regenerate the ruleset from scratch, however, run gen.py with the r mode.