aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps/content/utils.py
diff options
context:
space:
mode:
authorGravatar ks129 <[email protected]>2020-10-04 18:55:33 +0300
committerGravatar ks129 <[email protected]>2020-10-04 18:55:33 +0300
commitaff3a89c3cec04eda096e8f27115e36108ee6286 (patch)
tree299fb51b60916e6b552fa1ac7e0e05dbef512343 /pydis_site/apps/content/utils.py
parentAdd more information to how to write a guide guide (diff)
Change guides system to content system
As this system will be used for more than just guides, I had to do some refactoring to match this system with plans. Basically now there isn't guides, but articles instead.
Diffstat (limited to 'pydis_site/apps/content/utils.py')
-rw-r--r--pydis_site/apps/content/utils.py77
1 files changed, 77 insertions, 0 deletions
diff --git a/pydis_site/apps/content/utils.py b/pydis_site/apps/content/utils.py
new file mode 100644
index 00000000..57905a69
--- /dev/null
+++ b/pydis_site/apps/content/utils.py
@@ -0,0 +1,77 @@
+import os
+from typing import Dict, Optional, Union
+
+import yaml
+from django.conf import settings
+from django.http import Http404
+from markdown import Markdown
+
+
+def _get_base_path() -> str:
+ """Have extra function for base path getting for testability."""
+ return os.path.join(settings.BASE_DIR, "pydis_site", "apps", "content", "resources", "content")
+
+
+def get_category(category: str) -> Dict[str, str]:
+ """Load category information by name from _info.yml."""
+ path = os.path.join(_get_base_path(), category)
+ if not os.path.exists(path) or not os.path.isdir(path):
+ raise Http404("Category not found.")
+
+ with open(os.path.join(path, "_info.yml")) as f:
+ return yaml.safe_load(f.read())
+
+
+def get_categories() -> Dict[str, Dict]:
+ """Get all categories information."""
+ base_path = _get_base_path()
+ categories = {}
+
+ for name in os.listdir(base_path):
+ if os.path.isdir(os.path.join(base_path, name)):
+ categories[name] = get_category(name)
+
+ return categories
+
+
+def get_articles(category: Optional[str] = None) -> Dict[str, Dict]:
+ """Get all root content when category is not specified. Otherwise get all this category content."""
+ if category is None:
+ base_dir = _get_base_path()
+ else:
+ base_dir = os.path.join(_get_base_path(), category)
+
+ articles = {}
+
+ for filename in os.listdir(base_dir):
+ full_path = os.path.join(base_dir, filename)
+ if os.path.isfile(full_path) and filename.endswith(".md"):
+ md = Markdown(extensions=['meta'])
+ with open(full_path) as f:
+ md.convert(f.read())
+
+ articles[os.path.splitext(filename)[0]] = md.Meta
+
+ return articles
+
+
+def get_article(article: str, category: Optional[str]) -> Dict[str, Union[str, Dict]]:
+ """Get one specific article. When category is specified, get it from there."""
+ if category is None:
+ base_path = _get_base_path()
+ else:
+ base_path = os.path.join(_get_base_path(), category)
+
+ if not os.path.exists(base_path) or not os.path.isdir(base_path):
+ raise Http404("Category not found.")
+
+ article_path = os.path.join(base_path, f"{article}.md")
+ if not os.path.exists(article_path) or not os.path.isfile(article_path):
+ raise Http404("Article not found.")
+
+ md = Markdown(extensions=['meta', 'attr_list', 'fenced_code'])
+
+ with open(article_path) as f:
+ html = md.convert(f.read())
+
+ return {"article": html, "metadata": md.Meta}