feat(readme): finish generator

Author: amadaluzia

.editorconfig

@@ -0,0 +1,5 @@
+root = true
+
+[*.py]
+indent_style = space
+indent_size = 4

CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# Contributing to the Code of Conduct
+
+> [!NOTE]
+> This is a living document, and will grow with time. Please be aware
+> that nothing in this document will last forever. Check back whenever
+> you want to contribute.
+
+## How the Code of Conduct is created
+
+Rules are made from sections, these sections are in a
+`section{index}.toml` that you can find in `code_of_conduct/sections/`.
+This is done to standardise the code of conduct format, as well as
+making it portable in case it were to be used in our own Tux for
+example. There are some quirks with the format due to using Markdown
+which will be described in this document.
+
+## How to add new rules
+
+A rule can be added by opening the section you want to add a new rule
+to (read [here](#how-to-add-a-new-section) if you want to make a new
+section) and add something of the following format:
+
+```toml
+[[rule]]
+# EXPECTED TO EXIST
+title = "My new rule"
+description = """
+I am describing my new rule.
+"""
+
+# OPTIONAL
+[[rule.expectations]]
+expectation = "Mild"
+description = """
+Hello world! This is your punishment for doing something bad! Feel the
+wrath of the sword!
+"""
+
+[[rule.glossary]]
+word = "describing"
+meaning = "talking about"
+```
+
+You are expected to keep every line around 72 characters long for
+readability purposes. You also should aim to use listing less as
+paragraphs tend to work just about as well without being unmemorable.
+Make sure the quotes and the text are separate from each other for
+readability.
+
+## How to add a new section
+
+To create a new section, you can create a new file in
+`code_of_conduct/sections`. Preferably, you can name it
+`section{index}.toml` for consistency. You must write it out like below:
+```toml
+title = "My section"
+
+[[rule]]
+title = "My rule"
+description = "Description of my rule."
+
+# fill in the rest
+```
+
+## What to do after you made your changes
+
+CI is not setup for this yet. As such, you will have to set up a
+development environment for Python **3.11 and higher** to regenerate
+the README file. This isn't an annoying process but we will eventually
+add CI to make this step irrelevant.
+
+### Setting up your .venv
+
+Before setting up `.venv`, please make sure you are running version
+3.11 or above by running `python --version`. After checking and
+verifying that you have a high enough version, you can setup a .venv by
+running this command in your shell:
+```
+$ python -m venv .venv
+```
+This will create a .venv directory which will contain a local
+development environment you can access by sourcing `.venv/bin/activate`.
+You will want to check for an activation script that supports your shell
+however. If you are on PowerShell, you will need to source
+`.venv/bin/activate.ps1`, fish users must source `activate.fish` and so
+on with other shells.
+
+Once you are in your .venv environment, make sure pip is up to date by
+running this command:
+```
+pip install --upgrade pip
+```
+This is to prevent any vulnerabilities when installing software via pip,
+and therefore it will be safer. We will now need `poetry` as pip doesn't
+have a stable lockfile format as of now.
+
+To install `poetry`, you must run this command:
+```
+$ pip install poetry
+```
+You will then be able to use poetry to install our package as well as
+any dependencies needed for said package. This can be done by running
+the following command:
+```
+$ poetry install
+```
+
+You can then generate the README by running the following command:
+```
+$ python -m code_of_conduct
+```
+The README will then be modified to include your changed you made. You
+can now commit your work and make a pull request.

README.md

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

code_of_conduct/__init__.py

@@ -0,0 +1,35 @@
+import os
+import sys
+import tomllib
+
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+from pathlib import Path
+
+
+def read_file(fp: Path) -> str:
+    with fp.open("r") as f:
+        return f.read()
+
+
+def main() -> None:
+    sections: list[map] = []
+    env = Environment(
+        loader=PackageLoader("code_of_conduct"),
+        autoescape=select_autoescape(),
+    )
+
+    for dirpath, _, filenames in os.walk("./code_of_conduct/sections/"):
+        filenames.sort()
+        for filename in filenames:
+            output = read_file(Path(dirpath) / Path(filename))
+            sections.append(tomllib.loads(output))
+
+    template = env.get_template("README.md.jinja")
+
+    with Path("README.md").open("w") as f:
+        print(template.render(sections=sections), file=f)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

code_of_conduct/__main__.py

@@ -24,15 +24,11 @@ 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"
@@ -108,19 +104,25 @@ violent incidents, supporting those who perpetrate violent acts, or
 promoting conspiracy theories that may incite violence towards others,
 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.
+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.
 """
 
 [[rule.expectations]]
 expectation = "Mild"
-description = "Pulling Members into tickets and requesting that they stop this behavior"
+description = """
+Pulling Members into tickets and requesting that they
+stop this behavior
+"""
 
 [[rule.expectations]]
 expectation = "Medium"
-description = "Reprimand within tickets and timeouts ranging from 1hr-12hr"
+description = """
+Reprimand within tickets and timeouts ranging from
+1hr-12hr
+"""
 
 [[rule.expectations]]
 expectation = "Severe"

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

@@ -13,10 +13,14 @@ description = """
 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
 """
+
+[[rule.expectations]]
 expectation = "Severe"
 description = """
 If a Member is unwilling to comply, Moderators may act as they see fit.
@@ -36,16 +40,21 @@ 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
 """
+
+[[rule.expectations]]
 expectation = "Medium"
 description = """
 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

code-of-conduct/sections/2.toml renamed to code_of_conduct/sections/section2.toml

@@ -0,0 +1,82 @@
+<!-- !!! PLEASE CHECK CONTRIBUTING.MD BEFORE ADDING TO THE CODE OF CONDUCT !!! -->
+![Discord Banner 1](https://i.imgur.com/6kxPNlG.png)
+<p align="center">
+  <img src="https://discordapp.com/api/guilds/1172245377395728464/widget.png?style=shield" alt="Discord Shield">
+  <img src="https://dcbadge.vercel.app/api/server/linux?style=flat&theme=clean" alt="Discord Banner 2">
+</p>
+
+
+<h1 align="center">All Things Linux</h1>
+
+Welcome to "All Things Linux," a vibrant and inclusive community dedicated to exploring the vast and varied world of Linux. Our mission is to provide a friendly and supportive environment where enthusiasts, professionals, hobbyists, and newcomers alike can share their passion, knowledge, and experiences with Linux. Whether it's discussing the newest distributions, offering tips and tricks, troubleshooting, or celebrating the open-source spirit, "All Things Linux" is a place for collaboration, learning, and fostering a deeper appreciation for an operating system that powers much of the digital world. Join us as we navigate the limitless possibilities of Linux together!
+
+---
+
+# Code of Conduct
+
+**Table of Contents**
+
+- [Preface](#preface)
+    - [Discord Community Guidelines and Terms of Service](#discord-community-guidelines-and-terms-of-service)
+{% for section in sections %}- [Section {{ loop.index }}. {{ section.title }}](#section-{{ loop.index }}-{{ section.title | lower | replace(' ', '-') }})
+{% set section_loop = loop %}{% for rule in section.rule %}    - [{{ section_loop.index }}.{{ loop.index }}. {{ rule.title }}](#{{section_loop.index}}{{loop.index}}-{{ rule.title | lower | replace(' ', '-') | replace(':', '') }})
+{% endfor %}{% endfor %}
+
+## Preface
+
+### Discord Community Guidelines and Terms of Service
+
+Your presence in this server implies accepting Discord’s Community Guidelines and Terms of Service, including all further changes. These changes might be done at any time with or without notice, it is your responsibility to consistently review and follow them.
+
+- [Discord Community Guidelines](https://discord.com/guidelines)
+- [Discord Terms of Service](https://discord.com/terms)
+
+{% for section in sections %}## Section {{ loop.index }}. {{ section.title }}
+{% set section_loop = loop %}
+{% for rule in section.rule %}
+### {{ section_loop.index }}.{{ loop.index }}. {{ rule.title }}
+{{ rule.description }}
+{% if rule.expectations %}
+#### Examples of moderation expectations
+
+| Expectation | Description |
+| --- | --- |
+{% for expectation in rule.expectations %}| {{ expectation.expectation}} | {{ expectation.description | replace('\n', ' ') }} |
+{% endfor %}
+{% endif %}
+{% if rule.glossary %}
+#### Glossary
+
+| Word | Meaning |
+| --- | --- |
+{% for word in rule.glossary %}| {{ word.word }} | {{ word.meaning | replace('\n', ' ') }} |
+{% endfor %}
+{% endif %}
+{% endfor %}
+{% endfor %}
+
+## Notice
+
+Please note that this article cannot capture all rules and that each situation needs to be assessed individually. Attempting to exploit any "loopholes" within these guidelines is strictly forbidden.
+
+These guidelines are ever-evolving, responding to varied circumstances. Hence, we might take necessary action against members or content that contradicts the core intent of these rules, even if it is not directly mentioned in the current version.
+
+Moderator actions may cite rules from this document. Please be aware that section numbers may change over time and may not be the same when the action was issued. Sections referenced do not imply their respective subsections (e.g. citing 1.2 does not imply 1.2.c).
+
+We aim to keep you updated whenever these guidelines get revised. However, the responsibility lies with you to upkeep the essence of these rules: to maintain the safety of Discord and uphold its inclusivity. Stay informed about server announcements and polls which might induce changes to the rules. We appreciate your contribution in this regard.
+
+Above all, exercise good judgment and common sense.
+
+## Contributors
+
+<sub>Made with [contrib.rocks](https://contrib.rocks).</sub>
+
+[![Contributors](https://contrib.rocks/image?repo=allthingslinux/code-of-conduct)](https://github.com/allthingslinux/code-of-conduct/graphs/contributors)
+
+## License
+
+This work is licensed under the Creative Commons Attribution 4.0 International License.
+To view a copy of this license, visit https://creativecommons.org/licenses/by/4.0/
+
+Creative Commons Attribution 4.0 International
+© 2025 All Things Linux