aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps/events
diff options
context:
space:
mode:
authorGravatar Rohan Reddy Alleti <[email protected]>2023-05-14 23:54:51 +0530
committerGravatar GitHub <[email protected]>2023-05-14 23:54:51 +0530
commita241a397f966a4265935dfd5c92a84fdf95c52c8 (patch)
tree83f6eb572e26e64e6ca18642013abf60f1b23d8b /pydis_site/apps/events
parentUpdate pydis_site/apps/content/resources/guides/python-guides/subclassing_bot.md (diff)
parentMerge pull request #972 from python-discord/fix-psycopg3-compatibility-in-met... (diff)
Merge branch 'main' into subclassing_bot
Diffstat (limited to 'pydis_site/apps/events')
-rw-r--r--pydis_site/apps/events/README.md19
-rw-r--r--pydis_site/apps/events/apps.py2
-rw-r--r--pydis_site/apps/events/urls.py2
-rw-r--r--pydis_site/apps/events/views/page.py3
4 files changed, 22 insertions, 4 deletions
diff --git a/pydis_site/apps/events/README.md b/pydis_site/apps/events/README.md
new file mode 100644
index 00000000..f0d20510
--- /dev/null
+++ b/pydis_site/apps/events/README.md
@@ -0,0 +1,19 @@
+# The "events" app
+
+This application serves mostly static pages that showcase events we run on our
+community. You most likely want to look at the [templates
+directory](../../templates/events) for this app if you want to change anything.
+
+## Directory structure
+
+This app has a relatively minimal structure:
+
+- `migrations` is empty as we don't work with any models here.
+
+- `tests` contains a few tests to make sure that serving our events pages works.
+
+- `views` contains Django views that concern themselves with looking up the
+ matching Django template.
+
+The actual content lives in the [templates directory two layers
+up](../../templates/events).
diff --git a/pydis_site/apps/events/apps.py b/pydis_site/apps/events/apps.py
index a1cf09ef..70762bc2 100644
--- a/pydis_site/apps/events/apps.py
+++ b/pydis_site/apps/events/apps.py
@@ -4,4 +4,4 @@ from django.apps import AppConfig
class EventsConfig(AppConfig):
"""Django AppConfig for events app."""
- name = 'events'
+ name = 'pydis_site.apps.events'
diff --git a/pydis_site/apps/events/urls.py b/pydis_site/apps/events/urls.py
index 7ea65a31..6121d264 100644
--- a/pydis_site/apps/events/urls.py
+++ b/pydis_site/apps/events/urls.py
@@ -8,7 +8,7 @@ from pydis_site.apps.events.views import IndexView, PageView
app_name = "events"
-def __get_all_files(root: Path, folder: typing.Optional[Path] = None) -> list[str]:
+def __get_all_files(root: Path, folder: Path | None = None) -> list[str]:
"""Find all folders and HTML files recursively starting from `root`."""
if not folder:
folder = root
diff --git a/pydis_site/apps/events/views/page.py b/pydis_site/apps/events/views/page.py
index 1622ad70..adf9e952 100644
--- a/pydis_site/apps/events/views/page.py
+++ b/pydis_site/apps/events/views/page.py
@@ -1,4 +1,3 @@
-from typing import List
from django.conf import settings
from django.http import Http404
@@ -8,7 +7,7 @@ from django.views.generic import TemplateView
class PageView(TemplateView):
"""Handles event pages showing."""
- def get_template_names(self) -> List[str]:
+ def get_template_names(self) -> list[str]:
"""Get specific template names."""
path: str = self.kwargs['path']
page_path = settings.EVENTS_PAGES_PATH / path