Added How To Python README Automation (#39)

* Starting the How To Python README code

* Created the README header

* Added RSS reading

* Added YouTube video automation

* Removed code snippet article

* Added challenge support

* Automated all columns

* Incremented software version

Author: jrg94

.gitignore

@@ -109,3 +109,5 @@ venv.bak/
 # Wiki
 /generate_docs/wiki/
 /generate_docs/readme/
+generate_docs/how_to/README.md
+generate_docs/README.md

generate_docs/generator.py

@@ -4,6 +4,7 @@
 from generate_docs.readme import ReadMeCatalog
 from generate_docs.repo import Repo
 from generate_docs.wiki import Wiki
+from generate_docs.how_to import HowTo
 
 
 class Generator:
@@ -62,6 +63,12 @@ def main_readmes():
     _create_generator().generate_readmes()
 
 
+def main_how_to():
+    how_to = HowTo()
+    how_to.page.output_page("")
+
+
 if __name__ == '__main__':
     main_wiki()
     main_readmes()
+    main_how_to()

generate_docs/how_to.py

@@ -0,0 +1,93 @@
+from typing import Optional
+from bs4 import BeautifulSoup
+import requests
+import feedparser
+
+from generate_docs.markdown import MarkdownPage
+
+
+def get_intro_text():
+    return """Welcome to a collection of Jupyter Notebooks from the 
+    [How to Python](https://therenegadecoder.com/series/how-to-python/) series on The Renegade Coder. For convenience, 
+    you can access all of the articles, videos, challenges, and source code below. Alternatively, I keep 
+    [an enormous article](https://therenegadecoder.com/code/python-code-snippets-for-everyday-problems/) up to date 
+    with all these snippets as well.
+    """
+
+
+def get_series_posts():
+    index = 1
+    base = "https://therenegadecoder.com/series/how-to-python/feed/?paged="
+    feed = []
+    while (rss := feedparser.parse(f"{base}{index}")).entries:
+        feed.extend(rss.entries)
+        index += 1
+    return feed
+
+
+def get_youtube_video(entry):
+    content = entry.content[0].value
+    soup = BeautifulSoup(content, "html.parser")
+    target = soup.find("h2", text="Video Summary")
+    if target:
+        return target.find_next_sibling().find_all("a")[-1]["href"]
+
+
+def get_slug(title: str, sep: str):
+    return title.split(":")[0][:-10].lower().replace(" ", sep)
+
+
+def get_challenge(title: str):
+    slug = get_slug(title, "-")
+    base = "https://github.com/TheRenegadeCoder/how-to-python-code/tree/master/challenges/"
+    print(f"Trying {base}{slug}")
+    request = requests.get(f"{base}{slug}")
+    if request.status_code == 200:
+        return f"{base}{slug}"
+
+
+def get_notebook(title: str):
+    slug = get_slug(title, "_")
+    base = "https://github.com/TheRenegadeCoder/how-to-python-code/tree/master/notebooks/"
+    print(f"Trying {base}{slug}.ipynb")
+    request = requests.get(f"{base}{slug}.ipynb")
+    if request.status_code == 200:
+        return f"{base}{slug}.ipynb"
+
+
+class HowTo:
+    def __init__(self):
+        self.page: Optional[MarkdownPage] = None
+        self.feed: Optional[list] = None
+        self._load_data()
+        self._build_readme()
+
+    def _load_data(self):
+        self.feed = get_series_posts()
+
+    def _build_readme(self):
+        self.page = MarkdownPage("README")
+
+        # Introduction
+        self.page.add_content("# How to Python - Source Code")
+        self.page.add_section_break()
+        self.page.add_content(get_intro_text())
+        self.page.add_section_break()
+
+        # Article List
+        self.page.add_table_header("Index", "Title", "Publish Date", "Article", "Video", "Challenge", "Notebook")
+        self.build_table()
+
+    def build_table(self):
+        index = 1
+        for entry in self.feed:
+            if "Code Snippets" not in entry.title:
+                article = f"[Article]({entry.link})"
+                youtube_url = get_youtube_video(entry)
+                youtube = f"[Video]({youtube_url})" if youtube_url else ""
+                challenge_url = get_challenge(entry.title)
+                challenge = f"[Challenge]({challenge_url})" if challenge_url else ""
+                notebook_url = get_notebook(entry.title)
+                notebook = f"[Notebook]({notebook_url})" if notebook_url else ""
+                self.page.add_table_row(str(index), entry.title, entry.published, article, youtube, challenge, notebook)
+                index += 1

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="generate_docs",
-    version="2.2.0",
+    version="2.3.0",
     author="The Renegade Coder",
     author_email="jeremy.grifski@therenegadecoder.com",
     description="A docs generation package for the Sample Programs repo",
@@ -14,12 +14,16 @@
     url="https://github.com/TheRenegadeCoder/sample-programs-docs-generator",
     packages=setuptools.find_packages(),
     install_requires=[
-        "PyYAML~=5.4.1"
+        "PyYAML~=5.4.1",
+        "feedparser~=6.0.6",
+        "beautifulsoup4~=4.9.3",
+        "requests~=2.25.1"
     ],
     entry_points={
         "console_scripts": [
             'wikig = generate_docs.generator:main_wiki',
             'wikir = generate_docs.generator:main_readmes',
+            'wikih = generate_docs.generator:main_how_to'
         ],
     },
     classifiers=(