Tools

This directory includes the auxiliary tools below to support authoring and maintaining the Codacy documentation.

Install the Python requirements before using the tools:

pip3 install -r requirements.txt

export-meta-descriptions

Exports the meta descriptions from all pages referenced in a local sitemap.xml file to a CSV file.

$ ./export-meta-descriptions.py -h
usage: export-meta-descriptions.py [-h] [-o OUTPUT_PATH] sitemap-path

Exports meta descriptions from all pages referenced in a local sitemap.xml file to a CSV file.

positional arguments:
  sitemap-path          Path of a local sitemap.xml file.

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_PATH, --output-path OUTPUT_PATH
                        Path of the output CSV file. (default:
                        'descriptions.csv')