hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-08 10:34:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

switch generate-metrics to markdown

Browse Source
This commit is contained in:
Min RK
2022-12-07 09:02:09 +01:00
parent 832e8c0348
commit b859818a9c
1 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/generate-metrics.py
View File

@@ -1,7 +1,6 @@
import os import os
from pytablewriter import RstSimpleTableWriter from pytablewriter import MarkdownTableWriter
from pytablewriter.style import Style
import jupyterhub.metrics import jupyterhub.metrics
@@ -11,12 +10,11 @@ HERE = os.path.abspath(os.path.dirname(__file__))
class Generator: class Generator:
@classmethod @classmethod
def create_writer(cls, table_name, headers, values): def create_writer(cls, table_name, headers, values):
writer = RstSimpleTableWriter() writer = MarkdownTableWriter()
writer.table_name = table_name writer.table_name = table_name
writer.headers = headers writer.headers = headers
writer.value_matrix = values writer.value_matrix = values
writer.margin = 1 writer.margin = 1
[writer.set_style(header, Style(align="center")) for header in headers]
return writer return writer
def _parse_metrics(self): def _parse_metrics(self):
@@ -33,18 +31,17 @@ class Generator:
if not os.path.exists(generated_directory): if not os.path.exists(generated_directory):
os.makedirs(generated_directory) os.makedirs(generated_directory)
filename = f"{generated_directory}/metrics.rst" filename = f"{generated_directory}/metrics.md"
table_name = "" table_name = ""
headers = ["Type", "Name", "Description"] headers = ["Type", "Name", "Description"]
values = self._parse_metrics() values = self._parse_metrics()
writer = self.create_writer(table_name, headers, values) writer = self.create_writer(table_name, headers, values)
title = "List of Prometheus Metrics"
underline = "============================"
content = f"{title}\n{underline}\n{writer.dumps()}"
with open(filename, 'w') as f: with open(filename, 'w') as f:
f.write(content) f.write("# List of Prometheus Metrics\n\n")
print(f"Generated {filename}.") f.write(writer.dumps())
f.write("\n")
print(f"Generated {filename}")
def main(): def main():