modis/GenerateReadme.py at master · ModisWorks/modis · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
"""Generate a README.md file for Modis"""

from modis.tools import config, moduledb, version


def add_md(text, s, level=0):
    """Appends text to a markdown.

    Args:
        text (str): The old text.
        s (str): The text to append.
        level (int): The markdown level of the appended text.

    Returns:
        text (str): The updated text
    """

    if level > 0:
        if text != "":
            text += "\n"
        text += "#" * level
        text += " "

    text += s + "\n"

    if level > 0:
        text += "\n"

    return text


def add_ul(text, ul):
    """Appends an unordered list to a markdown.

    Args:
        text (str): The old text.
        ul (list): The list to append.

    Returns:
        text (str): The updated text.
    """

    text += "\n"
    for li in ul:
        text += "- " + li + "\n"
    text += "\n"

    return text


readme = ""

# Title
readme = add_md(readme, "MODIS", 1)
readme = add_md(readme, "Latest release: [v{0}{1}]({2}/{0})".format(
    version.VERSION,
    " Beta" if version.VERSION[0] < "1" else "",
    "https://github.com/Infraxion/modis/releases/tag"
))

# About
readme = add_md(readme, "About Modis", 2)
readme = add_md(readme, "Modis is an highly modular, open-source Discord bot "
                        "that runs with a console GUI. Our goal is to make "
                        "Modis as easy to host as possible, so that any "
                        "Discord user can host their own bot. Modis is also "
                        "designed to be very easy to develop for; it's "
                        "modularised in a way that makes it very easy to "
                        "understand for anyone familiar with the discord.py "
                        "Python library.\n\n"
                        "We hope that this bot introduces more novices to the "
                        "painful world of software development and networking, "
                        "and provides seasoned devs with something to "
                        "procrastinate their deadline on. Have fun!")

# Module list
module_names = moduledb.get_names()
readme = add_md(readme, "Current Modules", 2)
readme = add_md(readme, "There are currently {} available modules:".format(len(module_names)))

module_list = []
for module_name in module_names:
    info = moduledb.get_import_specific("__info", module_name)
    if not info:
        module_list.append("`{}`".format(module_name))
        continue
    if not info.BLURB:
        module_list.append("`{}`".format(module_name))
        continue
    module_list.append("`{}` - {}".format(module_name, info.BLURB))
readme = add_ul(readme, module_list)

readme = add_md(readme, "More detailed information about each module and how "
                        "to use them can be found in the [docs](https://"
                        "infraxion.github.io/modis/documentation/#modules).")

# Write file
print(readme)
newreadme_path = "{}/../README.md".format(config.ROOT_DIR)
with open(newreadme_path, 'w') as file:
    file.write(readme)