Merge branch 'main' into swfarnsworth/resources

Author: swfarnsworth

.github/ISSUE_TEMPLATE/resource_suggestion.md

@@ -11,12 +11,3 @@
 - [ ] Joined the [Python Discord community](discord.gg/python)
 - [ ] Read the [Code of Conduct](https://www.pydis.com/pages/code-of-conduct) and agree to it
 - [ ] I have discussed implementing this feature on the relevant service (Discord, GitHub, etc.)
-
-
-### I have changed API models and I ensure I have:
-<!-- Please remove this section if you haven't edited files under pydis_site/apps/api/models -->
-- [ ] Opened a PR updating the model on the [API GitHub Repository](https://github.com/python-discord/api)
-
-**OR**
-
-- [ ] Opened an issue on the [API GitHub Repository](https://github.com/python-discord/api) explaining what changes need to be made

.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -129,3 +129,6 @@ log.*
 
 # Local Netlify folder
 .netlify
+
+# Mac/OSX
+.DS_Store

.gitignore

@@ -0,0 +1,68 @@
+# `pydis_site` project directory
+
+This directory hosts the root of our **Django project**[^1], and is responsible
+for all logic powering our website. Let's go over the directories in detail:
+
+- [`apps`](./apps) contains our **Django apps**, which are the building blocks
+  that make up our Django project. A Django project must always consist of one
+  or more apps, and these apps can be made completely modular and reusable
+  across any Django project. In our project, each app controls a distinct part
+  of our website, such as the API or our resources system.
+
+  For more information on reusable apps, see the official Django tutorial,
+  [which has a section on reusable
+  apps](https://docs.djangoproject.com/en/dev/intro/reusable-apps/). To learn
+  more about our specific apps, see the README inside the app folder itself.
+
+- [`static`](./static) contains our **static files**, such as CSS, JavaScript,
+  images, and anything else that isn't either content or Python code. Static
+  files relevant for a specific application are put into subdirectories named
+  after the application. For example, static files used by the `resources` app go in `static/resources`.
+
+- [`templates`](./templates) contains our **[Django
+  templates](https://docs.djangoproject.com/en/dev/topics/templates/)**. Like
+  with static files, templates specific to a single application are stored in a
+  subdirectory named after that application. We also have two special templates
+  here:
+
+  - `404.html`, which is our error page shown when a site was not found.
+
+  - `500.html`, which is our error page shown in the astronomically rare case
+    that we encounter an internal server error.
+
+
+Note that for both `static` and `templates`, we are not using the default Django
+directory structure which puts these directories in a directory per app (in our
+case, this would for example be ``pydis_site/apps/content/static/``).
+
+We also have a few files in here that are relevant or useful in large parts of
+the website:
+
+- [`context_processors.py`](./context_processors.py), which contains custom
+  *context processors* that add variables to the Django template context. To
+  read more, see the [`RequestContext` documentation from
+  Django](https://docs.djangoproject.com/en/dev/ref/templates/api/#django.template.RequestContext)
+
+- [`settings.py`](./settings.py), our Django settings file. This controls all
+  manner of crucial things, for instance, we use it to configure logging, our
+  connection to the database, which applications are run by the project, which
+  middleware we are using, and variables for `django-simple-bulma` (which
+  determines frontend colours & extensions for our pages).
+
+- [`urls.py`](./urls.py), the URL configuration for the project itself. Here we
+  can forward certain URL paths to our different apps, which have their own
+  `urls.py` files to configure where their subpaths will lead. These files
+  determine _which URLs will lead to which Django views_.
+
+- [`wsgi.py`](./wsgi.py), which serves as an adapter for
+  [`gunicorn`](https://github.com/benoitc/gunicorn),
+  [`uwsgi`](https://github.com/unbit/uwsgi), or other application servers to run
+  our application in production. Unless you want to test an interaction between
+  our application and those servers, you probably won't need to touch this.
+
+
+For more information about contributing to our projects, please see our
+[Contributing
+page](https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/).
+
+[^1]: See [Django Glossary: project](https://docs.djangoproject.com/en/dev/glossary/#term-project)

pydis_site/README.md

@@ -0,0 +1,71 @@
+# The "api" app
+
+This application takes care of most of the heavy lifting in the site, that is,
+allowing our bot to manipulate and query information stored in the site's
+database.
+
+We make heavy use of [Django REST
+Framework](https://www.django-rest-framework.org) here, which builds on top of
+Django to allow us to easily build out the
+[REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API
+consumed by our bot. Working with the API app requires basic knowledge of DRF -
+the [quickstart
+guide](https://www.django-rest-framework.org/tutorial/quickstart/) is a great
+resource to get started.
+
+## Directory structure
+
+Let's look over each of the subdirectories here:
+
+- `migrations` is the standard Django migrations folder. You usually won't need
+  to edit this manually, as `python manage.py makemigrations` handles this for
+  you in case you change our models. (Note that when generating migrations and
+  Django doesn't generate a human-readable name for you, please supply one
+  manually using `-n add_this_field`.)
+
+- `models` contains our Django model definitions. We put models into subfolders
+  relevant as to where they are used - in our case, the `bot` folder contains
+  models used by our bot when working with the API. Each model is contained
+  within its own module, such as `api/models/bot/message_deletion_context.py`,
+  which contains the `MessageDeletionContext` model.
+
+- `tests` contains tests for our API. If you're unfamilar with Django testing,
+  the [Django tutorial introducing automated
+  testing](https://docs.djangoproject.com/en/dev/intro/tutorial05/) is a great
+  resource, and you can also check out code in there to see how we test it.
+
+- `viewsets` contains our [DRF
+  viewsets](https://www.django-rest-framework.org/api-guide/viewsets/), and is
+  structured similarly to the `models` folder: The `bot` subfolder contains
+  viewsets relevant to the Python Bot, and each viewset is contained within its
+  own module.
+
+The remaining modules mostly do what their name suggests:
+
+- `admin.py`, which hooks up our models to the [Django admin
+  site](https://docs.djangoproject.com/en/dev/ref/contrib/admin/).
+
+- `apps.py` contains the Django [application
+  config](https://docs.djangoproject.com/en/dev/ref/applications/) for the `api`
+  app, and is used to run any code that should run when the app is loaded.
+
+- `pagination.py` contains custom
+  [paginators](https://www.django-rest-framework.org/api-guide/pagination/) used
+  within our DRF viewsets.
+
+- `serializers.py` contains [DRF
+  serializers](https://www.django-rest-framework.org/api-guide/serializers/) for
+  our models, and also includes validation logic for the models.
+
+- `signals.py` contains [Django
+  Signals](https://docs.djangoproject.com/en/dev/topics/signals/) for running
+  custom functionality in response to events such as deletion of a model
+  instance.
+
+- `urls.py` configures Django's [URL
+  dispatcher](https://docs.djangoproject.com/en/dev/topics/http/urls/) for our
+  API endpoints.
+
+- `views.py` is for any standard Django views that don't make sense to be put
+  into DRF viewsets as they provide static data or other functionality that
+  doesn't interact with our models.

pydis_site/apps/admin/__init__.py

@@ -0,0 +1,32 @@
+# Generated by Django 3.1.14 on 2022-03-06 16:07
+
+from django.db import migrations, models
+import django.db.models.deletion
+import pydis_site.apps.api.models.mixins
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0079_merge_20220125_2022'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AocAccountLink',
+            fields=[
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='api.user')),
+                ('aoc_username', models.CharField(help_text='The AoC username associated with the Discord User.', max_length=120)),
+            ],
+            bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
+        ),
+        migrations.CreateModel(
+            name='AocCompletionistBlock',
+            fields=[
+                ('user', models.OneToOneField(help_text='The user that is blocked from getting the AoC Completionist Role', on_delete=django.db.models.deletion.CASCADE, primary_key=True, serialize=False, to='api.user')),
+                ('is_blocked', models.BooleanField(default=True, help_text='Whether this user is actively being blocked from getting the AoC Completionist Role', verbose_name='Blocked')),
+                ('reason', models.TextField(help_text='The reason for the AoC Completionist Role Block.', null=True)),
+            ],
+            bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
+        ),
+    ]

pydis_site/apps/admin/urls.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.1.14 on 2022-02-19 16:26
+
+import django.core.validators
+from django.db import migrations, models
+import pydis_site.apps.api.models.mixins
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0080_add_aoc_tables'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BumpedThread',
+            fields=[
+                ('thread_id', models.BigIntegerField(help_text='The thread ID that should be bumped.', primary_key=True, serialize=False, validators=[django.core.validators.MinValueValidator(limit_value=0, message='Thread IDs cannot be negative.')], verbose_name='Thread ID')),
+            ],
+            bases=(pydis_site.apps.api.models.mixins.ModelReprMixin, models.Model),
+        ),
+    ]

pydis_site/apps/api/README.md

@@ -0,0 +1,19 @@
+# Generated by Django 3.1.14 on 2022-04-21 23:29
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0081_bumpedthread'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='offtopicchannelname',
+            name='name',
+            field=models.CharField(help_text='The actual channel name that will be used on our Discord server.', max_length=96, primary_key=True, serialize=False, validators=[django.core.validators.RegexValidator(regex="^[a-z0-9\\U0001d5a0-\\U0001d5b9-ǃ？’'＜＞⧹⧸]+$")]),
+        ),
+    ]