Part of eRegulations.

Parse regulation XML to generate JSON for regulations-core to serve to regulations-site.

There are two types of RegML files:

• regulation files which contain the full text of a regulation version
• notice files which contain the changes necessary to transform the preceding version of a regulation into the next version

To generate RegML from an eCFR XML file using regulations-parser:

./regml.py ecfr 12 [eCFR File]

This will generate the RegML regulation tree for the initial version and RegML notice trees with the necessary changeset for each subsequent version.

If you want only want to output RegML for a single notice:

./regml.py ecfr 12 [eCFR File] --only-notice [notice number]

To apply a notice file to a regulation file:

./regml.py apply-notice [RegML regulation file] [RegML notice file]

This will create a new RegML file with the notice file's changes applied to the given regulation file.

The path to the RegML files can be relative to the XML_ROOT in your settings.py file. For example, if you have the RegML files in ../../regulations-stub/xml and your XML_ROOT="../../regulations-stub/xml", you can use:

./regml.py apply-notice 1111/1234-56789.xml 1111/1234-67890.xml

To validate a RegML file against regulations-schema:

./regml.py validate [RegML regulation or notice file]

Some utilities to sanitize RegML are also included

The term finder prompts the user to place references to defined terms wherever they may be found. These corrections can then be writen back to the original RegML file.

./regml.py check-terms [RegML regulation file]

check-terms also takes an optional label, which will cause it to only operate on that particular part of the regulation (useful for large regulations). For example:

./regml.py check-terms 1026/2011-31715 --label 1026-1
You appear to have used the term "Credit" in 1026-1-a without referencing it:
<content xmlns="eregs">...</content>

Would you like the automatically fix this reference in the source?
(y)es/(n)o/(i)gnore this term/(a)lways correct:

To generate JSON from RegML for use with regulations-core:

./regml.py json [RegML regulation file] []RegML regulation file] ...

If more than one RegML file is given, the JSON files that are created will include diff files that contain the changes between each version provided.

As with the other RegML commands above, the path to the RegML files can be relative to the XML_ROOT in your settings.py file. For example, if you have the RegML files in ../../regulations-stub/xml and your XML_ROOT="../../regulations-stub/xml", you can use:

./regml.py json 1111/1234-56789.xml

Additionally, to generate JSON for all RegML files in a particular regulation's directory in the XML_ROOT, you can simple use the regulation directory name (usually the part number):

./regml.py json 1111