Rolled Back Python Version Requirement to 3.8 (#25)

* Created a test file

* Added documentation

* Added some type hints

* Added some docs

* Incremented version

Author: jrg94

poetry.lock

@@ -2,7 +2,7 @@
 [tool.poetry]
 name = "ronbun"
 description = "The Sample Programs README Automation Tool"
-version = "0.7.3"
+version = "0.7.4"
 license = "MIT"
 
 authors = [
@@ -21,7 +21,7 @@ classifiers=[
 ]
 
 [tool.poetry.dependencies]
-python = "^3.11"
+python = "^3.8"
 snakemd = "^2.2.0b1"
 subete = "^0.16"
 

pyproject.toml

@@ -15,6 +15,9 @@
 
 
 def main():
+    """
+    The main drop in script for the README generation.
+    """
     ssl._create_default_https_context = ssl._create_unverified_context
     args = _get_args()
     numeric_level = getattr(logging, args[1].upper(), None)
@@ -31,6 +34,7 @@ def _get_args() -> tuple:
     """
     A helper function which gets the log level from 
     the command line. Set as warning from default. 
+
     :return: the log level provided by the user
     """
     parser = argparse.ArgumentParser()
@@ -49,6 +53,12 @@ def _get_args() -> tuple:
 
 
 def _get_intro_text(language: LanguageCollection) -> Paragraph:
+    """
+    Generates the test for the introduction of the README.
+
+    :param language: the language to generate from the LanguageCollection
+    :return: the introduction paragraph in the README
+    """
     paragraph = Paragraph([f"Welcome to Sample Programs in {language}! "])
     text = Inline("here.", link=language.lang_docs_url())
     if language.has_docs:
@@ -60,6 +70,7 @@ def _get_intro_text(language: LanguageCollection) -> Paragraph:
 def _generate_program_list(language: LanguageCollection) -> list:
     """
     A helper function which generates a list of programs for the README.
+
     :param language: a language collection
     :return: a list of sample programs list items
     """
@@ -76,8 +87,15 @@ def _generate_program_list(language: LanguageCollection) -> list:
     return list_items
 
 
-def _generate_missing_program_list(language: LanguageCollection, missing_programs: list[str]):
-    list_items = list()
+def _generate_missing_program_list(language: LanguageCollection, missing_programs: list[str]) -> list[Paragraph]:
+    """
+    Generates the list of programs that are missing in Markdown.
+
+    :param language: the language with missing programs
+    :param missing_programs: the list of programs missing from the language collection
+    :return: the missing programs lines as Markdown strings
+    """
+    list_items: list[Paragraph] = list()
     missing_programs.sort(key=lambda x: x.name())
     for program in missing_programs:
         program: Project
@@ -106,15 +124,22 @@ def _generate_credit() -> Paragraph:
     return p
 
 
-def _generate_program_list_header(program_count: int, total_program_count: int):
+def _generate_program_list_header(program_count: int, total_program_count: int) -> str:
+    """
+    Creates the heading test for the programs list.
+
+    :param program_count: the number of programs completed in the language
+    :param total_program_count: the total number of possible programs
+    :return: the heading about the program list
+    """
     i = int(((program_count / total_program_count) * 4))
     emojis = [":disappointed:", ":thinking:", ":relaxed:", ":smile:", ":partying_face:"]
     return f"Sample Programs List - {program_count}/{total_program_count} {emojis[i]}"
 
 
 class ReadMeCatalog:
     """
-    An representation of the collection of READMEs in the Sample Programs repo.
+    A representation of the collection of READMEs in the Sample Programs repo.
     """
 
     def __init__(self, repo: Repo):