Merge pull request #48 from kjaymiller/kjaymiller/issue10

Base Automation Scripts for GH Actions to Use

Author: kjaymiller

.gitignore

@@ -118,8 +118,6 @@ venv.bak/
 .ropeproject
 
 # mkdocs documentation
-/site
-
 # mypy
 .mypy_cache/
 .dmypy.json

app/src/build_issues.py

@@ -0,0 +1,3 @@
+import automation.engine as engine
+import automation.issues as issues
+import automation.newsletter as newsletter

automation/__init__.py

@@ -0,0 +1,25 @@
+"""Takes Issues Filed in the last week and puts them in a file for the upcoming stream"""
+import os
+import pathlib
+from datetime import datetime, timedelta
+
+from jinja2 import Environment, FileSystemLoader
+
+from engine import engine
+from issues import get_issues_from_github
+
+# Get the date of the next friday
+
+
+def create_post(*, filename: str | pathlib.Path, template: str, **metadata) -> int:
+    """Creates a markdown document for this week for render_engine to process"""
+    filename = pathlib.Path("app/content").joinpath(pathlib.Path(filename))
+    template = engine.get_template(template)
+    return filename.write_text(template.render(metadata))
+
+
+def get_show_file(directory: pathlib.Path, date: datetime.datetime) -> pathlib.Path:
+    """Get the file for a show on a given date"""
+    show_date = date.strftime("%Y-%m-%d")
+    show_file = pathlib.Path(directory).joinpath(show_date).with_suffix(".md")
+    return show_file

automation/archive.py

@@ -0,0 +1,3 @@
+from jinja2 import Environment, FileSystemLoader
+
+engine = Environment(loader=FileSystemLoader(["templates", "automation/templates"]))

automation/engine.py

@@ -0,0 +1,53 @@
+import datetime
+import re
+from collections import defaultdict
+from typing import Generator
+
+import httpx
+from markdown_it import MarkdownIt
+from markdown_it.tree import SyntaxTreeNode
+
+
+def get_issue(issue_id: str) -> dict[str, str]:
+    """Returns the issue with the given id"""
+    url = f"https://api.github.com/repos/kjaymiller/Python-Community-News/issues/{issue_id}"  # TODO: remove hardcoded issue url
+    request = httpx.get(url)
+    return request.json()
+
+
+def get_issues(labels, since_date: datetime.datetime | None) -> list:
+    """Returns the issues filed in the last week"""
+    url = "https://api.github.com/repos/kjaymiller/Python-Community-News/issues"
+    params = {"labels": ",".join(labels), "since": since_date}
+    request = httpx.get(url, params=params)
+    return request.json()
+
+
+def parse_issue_markdown(text) -> dict:
+    """Use markdownit to split at section headings"""
+    md = MarkdownIt("zero", {"maxNesting": 1})
+    md.enable(["heading", "paragraph"])
+    tokens = md.parse(text)
+    node = SyntaxTreeNode(tokens)
+    issue_object = defaultdict(list)
+    for n in node.children:
+        if n.type == "heading":
+            issue_key = n.children[0].content
+        elif content := n.children[0].content == "_No response_":
+            continue
+        else:
+            issue_object[issue_key].append(n.children[0].content)
+    return issue_object
+
+
+def get_content_issues(body, issues_tag: str) -> Generator[dict[str, str], None, None]:
+    """
+    Loads the issues from the file and returns the template show the newsletter.
+    """
+    md = parse_issue_markdown(body)
+
+    if issues_tag not in md:
+        raise ValueError(f"{issues_tag} is required in the issue")
+
+    issues = re.findall(r"\d+", md[issues_tag][0])
+    return issues

automation/issues.py

@@ -0,0 +1,56 @@
+import datetime
+import os
+import pathlib
+from typing import Generator
+
+import frontmatter
+import httpx
+
+hour = str
+minute = str
+buttondown_api_key = os.getenv("BUTTONDOWN_API_KEY")
+header = {"Authorization": f"Token {buttondown_api_key}"}
+
+schedule_email_url = "https://api.buttondown.email/v1/scheduled-emails"
+
+
+def get_publish_time(
+    date: datetime.datetime,
+    time: datetime.time,
+) -> datetime.datetime:
+    """Helper for getting the date and time for when to schedule the email"""
+    return datetime.datetime.combine(date, time)
+
+
+def build_email_from_content(
+    filepath: pathlib.Path,
+) -> dict[str, str]:
+    """
+    Uses frontmatter to get the subject and returns a partial of the body to be used to schedule the email.
+    """
+    content = frontmatter.load(filepath)
+    subject = content.metadata.get("subject")
+    body = {
+        "email_type": "public",
+        "body": content.content,
+        "subject": subject,
+    }
+    return body
+
+
+def schedule_email_from_post(
+    body: dict[str, str],
+    publish_date: datetime.datetime,
+) -> httpx.Response:
+    """
+    Returns the status code of the request.
+    The the `publish_date` time are required to schedule the email.
+    """
+
+    body.update({"publish_date": publish_date.isoformat()})
+    request = httpx.post(
+        schedule_email_url,
+        headers=header,
+        json=body,
+    )
+    return request

automation/newsletter.py

@@ -2,14 +2,28 @@
 title: Weekly Community News - {{date}}
 date: {{date}}
 tags: {{tags}}
+youtube: {{youtube}}
+podcast: {{podcast}}
 github: https://github.com/kjaymiller/Python-Community-News/blob/main/app/content/{{date}}.md
 ---
 
+## Topics
 {% for issue in issues %}
-# {{issue.title}}
+### {{issue.title}}
 
 <small>Submitted by: [{{issue.user.login}}]({{issue.user.url}}) on {{issue.created_at}}</small>
 
 {{issue.body}}
 
 {% endfor %}
+
+## Open CFPs and Upcoming Conferences
+### CFPs Open
+{% for cfp in cfps %}
+- [{{cfp.title}}]({{cfp.url}})
+{% endfor %}
+
+### Conferences
+{% for conference in conferences %}
+- [{{conference.title}}]({{conference.url}})
+{% endfor %}

templates/content_gen/episode_template.md renamed to automation/templates/archive.md

@@ -0,0 +1,21 @@
+---
+subject: Weekly Community News - {{date}}
+github: https://github.com/kjaymiller/Python-Community-News/blob/main/site/content/{{date}}.md
+youtube: {{youtube}}
+podcast: {{podcast}}
+---
+
+## Topics
+{% for issue in issues %}
+### {{issue.title}}
+
+<small>Submitted by: [{{issue.user.login}}]({{issue.user.url}}) on {{issue.created_at}}</small>
+
+{{issue.body}}
+{% endfor %}
+
+### Watch the VOD on Youtube:
+https://youtube.com/watch/{{youtube}}
+
+### Take the content on the road with you!
+https://transistor.fm/s/{{podcast}}