diff options
Diffstat (limited to '')
| -rw-r--r-- | scripts/README.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/scripts/README.rst b/scripts/README.rst new file mode 100644 index 0000000..6d96afd --- /dev/null +++ b/scripts/README.rst @@ -0,0 +1,21 @@ +Scripts +-------------------------- + +**docparser.py** + +Parses SGML files containing Postgres command information and converts them +into a JSON data structure, this is the converted into a python dictionary +and saved to `pgspecial/help/commands.py` + +This should me manually ran and the results committed after each new release +of the main Postgres project. + +SGML files can be found: https://github.com/postgres/postgres/tree/master/doc/src/sgml/ref +Grab a copy of this directory on your local system. + +**Usage** + +:: + pip install beautifulsoup4 + # From root of project + echo -n "helpcommands = " > pgspecial/help/commands.py; python scripts/docparser.py ref/ | python -mjson.tool | sed 's/"\: null/": None/g' >> pgspecial/help/commands.py |