feat(readme): finish generator

Author: amadaluzia

README.md

@@ -0,0 +1,4 @@
+import sys
+
+if __name__ == "__main__":
+    sys.exit(main())

code_of_conduct/__init__.py

@@ -0,0 +1,25 @@
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+import tomllib
+import json
+import sys
+import os
+
+def main() -> None:
+    sections = []
+    env = Environment(
+        loader=PackageLoader("code_of_conduct"),
+        autoescape=select_autoescape()
+    )
+
+    for filename in os.scandir(path="./code_of_conduct/sections/"):
+        with open(filename.path, "r") as f:
+            sections.append(tomllib.loads(f.read()))
+
+    template = env.get_template("README.md.jinja")
+
+    with open("README.md", "w") as f:
+        print(template.render(sections=sections), file=f)
+
+if __name__ == "__main__":
+    sys.exit(main())

code_of_conduct/__main__.py

@@ -12,27 +12,21 @@ that this platform does not offer such channels.
 
 Content you post, fictional or not must not be sexually explicit,
 neither can it contain gore, excessive violence, or animal abuse. Shock
-content is also forbidden.
-"""
+content is also forbidden."""
 
 [[rule.expectations]]
 expectation = "Mild"
 description = """
-First offenses will result in Members being brought into tickets
-and warned.
-"""
+First offenses will result in Members being brought into tickets \
+and warned."""
 
 [[rule.expectations]]
 expectation = "Medium"
-description = """
-Warns, tickets, and timeouts ranging from 1hr-12 hours.
-"""
+description = "Warns, tickets, and timeouts ranging from 1hr-12 hours."
 
 [[rule.expectations]]
 expectation = "Severe"
-description = """
-Bans are to be expected at this stage.
-"""
+description = "Bans are to be expected at this stage."
 
 [[rule.glossary]]
 word = "Content"
@@ -66,8 +60,7 @@ we will promptly investigate any behaviour that will undermine such
 safety. Moderation should be immediately alerted upon inappropriate
 behaviour in regards to minors. This marks pedophilia apologism as a
 threat and will therefore bring heavy repercussions, regardless of age
-claims, given sufficient context.
-"""
+claims, given sufficient context."""
 
 [[rule.glossary]]
 word = "Mature"
@@ -76,8 +69,7 @@ meaning = "Anything that can be considered 18+"
 [[rule.glossary]]
 word = "Pedophilia apologism"
 meaning = """
-Any action that supports, sympathise or encourage pedophilia.
-"""
+Any action that supports, sympathise or encourage pedophilia."""
 
 [[rule]]
 title = "Mutual Respect"
@@ -111,8 +103,7 @@ are all prohibited.
 Do not share media depicting harmful or offensive language and/or content,
 this can include or is not limited to; Offensive jokes or comments with the
 intention of causing harm or "drama". This may also include language that
-promotes exclusion or marginalization.
-"""
+promotes exclusion or marginalization."""
 
 [[rule.expectations]]
 expectation = "Mild"
@@ -134,8 +125,7 @@ disability, ethnicity, familial responsibilities, gender, gender
 identity, housing status, national origin, race, refugee or immigration
 status, religious affiliation, serious illness, sex, sexual orientation,
 socioeconomic class and status, income source, status as a victim of
-domestic violence, sexual violence, or stalking, and weight and size.
-"""
+domestic violence, sexual violence, or stalking, and weight and size."""
 
 
 [[rule]]
@@ -159,8 +149,7 @@ to, intervene, redirect, advise, or halt the conversation. These terms
 are not limited to a specific conversation but the mentioning of said
 topic. Our aim is not to suppress free speech but to keep an appropriate
 chatroom while promoting open, respectful, and harmonious conversations
-among all members.
-"""
+among all members."""
 
 [[rule.expectation]]
 expectation = "Mild"
@@ -173,9 +162,8 @@ description = "Forcing conversations to end"
 [[rule.expectation]]
 expectation = "Severe"
 description = """
-Members with repetitive offenses may receive timeouts and be addressed
-in tickets within 5m to 2 hours
-"""
+Members with repetitive offenses may receive timeouts and be addressed \
+in tickets within 5m to 2 hours"""
 
 
 [[rule.glossary]]
@@ -187,8 +175,7 @@ Topics including but not limited to, but are not limited to:
 - Religious belief systems and practices
 - Ongoing global conflicts and war
 - Historical atrocities and practices (such as Nazism, terrorism,
-  genocide, slavery, etc.)
-"""
+  genocide, slavery, etc.)"""
 
 [[rule]]
 title = "Avoidance of Elitism"
@@ -198,30 +185,26 @@ be it their choice of operating system, desktop environment, or other
 interests outside the main topics of the server. While friendly rivalry
 and banter can be elements of online communities, we don't welcome
 deliberate and obnoxious elitism. Respect for each other's preferences
-and diversity is a cardinal rule in our server.
-"""
+and diversity is a cardinal rule in our server."""
 
 [[rule.expectations]]
 expectation = "Mild"
 description = """
-Occasional or every now and then behavior usually doesn't require active
-moderation
-"""
+Occasional or every now and then behavior usually doesn't require active \
+moderation"""
 
 [[rule.expectations]]
 expectation = "Medium"
 description = """
-If a Member is repetitively being rude or unhealthy in their behavior,
-Moderators may ask them to stop
-"""
+If a Member is repetitively being rude or unhealthy in their behavior, \
+Moderators may ask them to stop"""
 
 [[rule.expectations]]
 expectation = "Severe"
 description = """
-If the behavior becomes a significant problem, Moderators may pull
-Members into tickets and respond accordingly based on their willingness
-to cooperate
-"""
+If the behavior becomes a significant problem, Moderators may pull \
+Members into tickets and respond accordingly based on their willingness \
+to cooperate"""
 
 [[rule]]
 title = "Respecting Authority & Rules"
@@ -233,8 +216,7 @@ the situation. Any rule violation should be reported via ticket, leaving
 the resolution to an authorized Moderator. While we discourage backseat
 moderating, we hope that members will help us maintain a healthy
 environment by guiding others if they are unaware of the rules or
-suggesting that certain behavior is inappropriate.
-"""
+suggesting that certain behavior is inappropriate."""
 
 [[rule]]
 title = "Piracy & Penetration Testing"
@@ -255,25 +237,21 @@ States of America.
 Promotion or support for malicious activities are strictly prohibited,
 regardless of intentions. You may discuss cybersecurity as long as
 directions are not provided on how to perform or exploit activities
-involving cybersecurity.
-"""
+involving cybersecurity."""
 
 [[rule.glossary]]
 word = "illegal redistribution"
 meaning = """
-Sharing and requesting content that cannot be accessed legally.
-"""
+Sharing and requesting content that cannot be accessed legally."""
 
 [[rule.glossary]]
 word = "malicious activities"
 meaning = """
 unauthorized access, data breaches, credential stuffing, phishing,
-malware development, or any other illegal hacking activities
-"""
+malware development, or any other illegal hacking activities"""
 
 [[rule.glossary]]
 word = "cybersecurity"
 meaning = """
 Topics including but not limited to: ethical hacking, penetration
-testing, and security vulnerabilities.
-"""
+testing, and security vulnerabilities."""

code-of-conduct/sections/1.toml renamed to code_of_conduct/sections/1.toml

@@ -10,17 +10,18 @@ text, voice, and support channels.
 [[rule.expectations]]
 expectation = "Mild"
 description = """
-Members will be kindly asked in the chat they are spreading non-English
-messages to keep it to English
-"""
+Members will be kindly asked in the chat they are spreading non-English \
+messages to keep it to English"""
+
+[[rule.expectations]]
 expectation = "Medium"
 description = """
-Repeated offenses may result in Members being pulled into tickets
-"""
+Repeated offenses may result in Members being pulled into tickets"""
+
+[[rule.expectations]]
 expectation = "Severe"
 description = """
-If a Member is unwilling to comply, Moderators may act as they see fit.
-"""
+If a Member is unwilling to comply, Moderators may act as they see fit."""
 
 [[rule]]
 title = "Text Channels"
@@ -36,20 +37,22 @@ This includes "brainrot" which are words or phrases with no substantial
 value as well as animal sounds or incoherent strings of letters.
 """
 
+[[rule.expectations]]
 expectation = "Mild"
 description = """
-Members will be kindly asked in the chat to not post
-low-effort/low-quality content or bypass automod
-"""
+Members will be kindly asked in the chat to not post \
+low-effort/low-quality content or bypass automod"""
+
+[[rule.expectations]]
 expectation = "Medium"
 description = """
-Repeated offenses may result in Members being timed out for a period of
-time at the moderators discretion
-"""
+Repeated offenses may result in Members being timed out for a period of \
+time at the moderators discretion"""
+
+[[rule.expectations]]
 expectation = "Severe"
 description = """
-If a Member is unwilling to comply, they will be ticketed and warned
-"""
+If a Member is unwilling to comply, they will be ticketed and warned"""
 
 [[rule]]
 title = "Voice Channels"
@@ -85,51 +88,44 @@ the rules.
 [[rule.expectations]]
 expectation = "Mild"
 description = """
-Moderators may ask members to adhere to guidelines. Moderators may
-temporarily server mute to ensure any issues are resolved.
-"""
+Moderators may ask members to adhere to guidelines. Moderators may \
+temporarily server mute to ensure any issues are resolved."""
 
 [[rule.expectations]]
 expectation = "Medium"
 description = """
-Members may be brought into tickets to talk with Moderators about their
-actions.
-"""
+Members may be brought into tickets to talk with Moderators about their \
+actions."""
 
 [[rule.expectations]]
 expectation = "Severe"
 description = """
-Members with severe infractions may be handled at the discretion of
-Moderators.
-"""
+Members with severe infractions may be handled at the discretion of \
+Moderators."""
 
 [[rule]]
 title = "Bot Usage"
 description = """
-Bot commands should be used in the bot commands channel. If a Member is
-found spamming, misusing, or abusing any Bot related features in the
-server, please report this via ticket.
-"""
+Bot commands should be used in the bot commands channel. If a Member is \
+found spamming, misusing, or abusing any Bot related features in the \
+server, please report this via ticket."""
 
 [[rule.expectations]]
 expectation = "Mild"
 description = """
-Members may be asked by Moderators to adhere to guidelines.
-"""
+Members may be asked by Moderators to adhere to guidelines."""
 
 [[rule.expectations]]
 expectation = "Medium"
 description = """
-Members may be brought into tickets to talk with Moderators about their
-actions.
-"""
+Members may be brought into tickets to talk with Moderators about their \
+actions."""
 
 [[rule.expectations]]
 expectation = "Severe"
 description = """
-Members with severe infractions may receive mutes ranging from 10
-minutes to 3 hours.
-"""
+Members with severe infractions may receive mutes ranging from 10 \
+minutes to 3 hours."""
 
 [[rule]]
 title = "On and Off-topic"
@@ -145,8 +141,7 @@ Moderator or send in a ticket as a last resort.
 
 Please do not derail support threads or comment on Moderator actions in
 community channels. If you have concerns or questions regarding a
-Moderator’s actions, create a ticket to discuss the matter.
-"""
+Moderator’s actions, create a ticket to discuss the matter."""
 
 [[rule]]
 title = "Spam"