punkweb-bb 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

punkweb_bb/migrations/0002_thread_view_count.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.11 on 2024-05-07 04:24
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("punkweb_bb", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="thread",
+            name="view_count",
+            field=models.PositiveIntegerField(default=0),
+        ),
+    ]

punkweb_bb/models.py

@@ -5,6 +5,7 @@ import os
 from django.contrib.auth import get_user_model
 from django.core.cache import cache
 from django.db import models
+from django.forms import ValidationError
 from django.urls import reverse
 from django.utils import timezone
 from precise_bbcode.fields import BBCodeTextField
@@ -107,6 +108,7 @@ class Thread(UUIDPrimaryKeyMixin, TimestampMixin):
     is_pinned = models.BooleanField(default=False)
     is_closed = models.BooleanField(default=False)
     last_post_created_at = models.DateTimeField(auto_now_add=True)
+    view_count = models.PositiveIntegerField(default=0)
 
     class Meta:
         ordering = (
@@ -161,6 +163,8 @@ class Post(UUIDPrimaryKeyMixin, TimestampMixin):
         return thread_url
 
     def save(self, *args, **kwargs):
+        if self.thread.is_closed:
+            raise ValidationError("Cannot add posts to a closed thread.")
         if self._state.adding:
             self.thread.last_post_created_at = timezone.now()
             self.thread.save()

punkweb_bb/settings.py

@@ -4,4 +4,5 @@ PUNKWEB_BB = getattr(settings, "PUNKWEB_BB", {})
 
 SITE_NAME = PUNKWEB_BB.get("SITE_NAME", "PUNKWEB")
 SITE_TITLE = PUNKWEB_BB.get("SITE_TITLE", "PunkwebBB")
+FAVICON = PUNKWEB_BB.get("FAVICON", "punkweb_bb/favicon.ico")
 SHOUTBOX_ENABLED = PUNKWEB_BB.get("SHOUTBOX_ENABLED", True)

punkweb_bb/static/punkweb_bb/css/profile.css

@@ -53,3 +53,10 @@
 .profile__thread:not(:last-of-type) {
   border-bottom: 1px solid var(--border);
 }
+
+@media screen and (max-width: 768px) {
+  .profile__info {
+    align-items: start;
+    flex-direction: column;
+  }
+}

punkweb_bb/templates/punkweb_bb/base.html

@@ -6,7 +6,7 @@
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>{% block title_prefix %}{% endblock %}{{ punkweb_bb.settings.SITE_TITLE|default:"PunkwebBB" }}</title>
-  <link rel="icon" href="{% static 'punkweb_bb/favicon.ico' %}" />
+  <link rel="icon" href="{% static punkweb_bb.settings.FAVICON %}" />
   <link rel="stylesheet" href="{% static 'punkweb_bb/vendor/open-color.css' %}" />
   <link rel="stylesheet" href="{% static 'punkweb_bb/vendor/prism.css' %}" />
   <link rel="stylesheet" href="{% static 'punkweb_bb/css/defaults.css' %}" />

punkweb_bb/templates/punkweb_bb/subcategory.html

@@ -1,5 +1,5 @@
 {% extends 'punkweb_bb/base.html' %}
-{% load static %}
+{% load static humanize_int %}
 
 {% block title_prefix %}{{subcategory.name}} | {% endblock%}
 
@@ -14,6 +14,9 @@
     <li class="pw-breadcrumb-item">
       <a href="{% url 'punkweb_bb:index' %}">Home</a>
     </li>
+    <li class="pw-breadcrumb-item">
+      <a href="{{subcategory.category.get_absolute_url}}">{{subcategory.category.name}}</a>
+    </li>
     <li class="pw-breadcrumb-item active">
       {{subcategory.name}}
     </li>
@@ -44,12 +47,14 @@
       <colgroup>
         <col span="1">
         <col span="1" width="96px">
+        <col span="1" width="96px">
         <col span="1" width="160px">
       </colgroup>
       <thead>
         <tr>
           <th>Title</th>
           <th>Posts</th>
+          <th>Views</th>
           <th></th>
         </tr>
       </thead>
@@ -74,6 +79,7 @@
               {{thread.created_at|date:'M j, Y'}}</div>
           </td>
           <td>{{thread.post_count}}</td>
+          <td>{{thread.view_count | humanize_int}}</td>
           <td>
             {% if thread.latest_post %}
             <div class="thread__latestPost">

punkweb_bb/templates/punkweb_bb/thread.html

@@ -21,6 +21,9 @@
     <li class="pw-breadcrumb-item">
       <a href="{% url 'punkweb_bb:index' %}">Home</a>
     </li>
+    <li class="pw-breadcrumb-item">
+      <a href="{{thread.subcategory.category.get_absolute_url}}">{{thread.subcategory.category.name}}</a>
+    </li>
     <li class="pw-breadcrumb-item">
       <a href="{{thread.subcategory.get_absolute_url}}">{{thread.subcategory.name}}</a>
     </li>
@@ -56,7 +59,7 @@
         <div class="thread__user__info__row">
           <div class="thread__user__info__label">Joined:</div>
           <div class="thread__user__info__value">
-            {{thread.user.profile.created_at|date:"M d, Y"}}
+            {{thread.user.date_joined|date:"M d, Y"}}
           </div>
         </div>
         <div class="thread__user__info__row">
@@ -117,7 +120,7 @@
         <div class="thread__user__info__row">
           <div class="thread__user__info__label">Joined:</div>
           <div class="thread__user__info__value">
-            {{post.user.profile.created_at|date:"M d, Y"}}
+            {{post.user.date_joined|date:"M d, Y"}}
           </div>
         </div>
         <div class="thread__user__info__row">

punkweb_bb/templates/punkweb_bb/thread_create.html

@@ -15,6 +15,9 @@
     <li class="pw-breadcrumb-item">
       <a href="{% url 'punkweb_bb:index' %}">Home</a>
     </li>
+    <li class="pw-breadcrumb-item">
+      <a href="{{subcategory.category.get_absolute_url}}">{{subcategory.category.name}}</a>
+    </li>
     <li class="pw-breadcrumb-item">
       <a href="{{subcategory.get_absolute_url}}">{{subcategory.name}}</a>
     </li>

punkweb_bb/templates/punkweb_bb/thread_update.html

@@ -15,6 +15,9 @@
     <li class="pw-breadcrumb-item">
       <a href="{% url 'punkweb_bb:index' %}">Home</a>
     </li>
+    <li class="pw-breadcrumb-item">
+      <a href="{{thread.subcategory.category.get_absolute_url}}">{{thread.subcategory.category.name}}</a>
+    </li>
     <li class="pw-breadcrumb-item">
       <a href="{{thread.subcategory.get_absolute_url}}">{{thread.subcategory.name}}</a>
     </li>

punkweb_bb/templatetags/humanize_int.py

@@ -0,0 +1,12 @@
+from django import template
+
+register = template.Library()
+
+
+@register.filter
+def humanize_int(value):
+    if value >= 1000000:
+        return f"{value / 1000000:.1f}M"
+    elif value >= 1000:
+        return f"{value / 1000:.1f}K"
+    return value

punkweb_bb/tests.py

@@ -2,7 +2,9 @@ import math
 
 from django.contrib.auth import get_user_model
 from django.core.cache import cache
-from django.test import TestCase
+from django.forms import ValidationError
+from django.test import Client, TestCase
+from django.urls import reverse
 from django.utils import timezone
 
 from punkweb_bb.models import (
@@ -141,7 +143,7 @@ class ThreadTestCase(TestCase):
         self.user = User.objects.create_user(username="test", password="test")
         self.category = Category.objects.create(name="test")
         self.subcategory = Subcategory.objects.create(
-            name="test", category=self.category
+            name="test", category=self.category, slug="test"
         )
 
     def test_thread_str(self):
@@ -175,6 +177,64 @@ class ThreadTestCase(TestCase):
 
         self.assertEqual(thread.latest_post, post_2)
 
+    def test_last_post_created_at(self):
+        thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        initial_last_post_created_at = thread.last_post_created_at
+        Post.objects.create(thread=thread, user=self.user, content="test")
+        new_last_post_created_at = thread.last_post_created_at
+
+        self.assertGreater(new_last_post_created_at, initial_last_post_created_at)
+
+    def test_is_closed(self):
+        thread = Thread.objects.create(
+            subcategory=self.subcategory,
+            user=self.user,
+            title="test",
+            content="test",
+            is_closed=True,
+        )
+        self.assertEqual(thread.is_closed, True)
+
+        post = Post(
+            thread=thread,
+            user=self.user,
+            content="test",
+        )
+
+        self.assertRaises(ValidationError, post.save)
+
+    def test_is_pinned(self):
+        thread = Thread.objects.create(
+            subcategory=self.subcategory,
+            user=self.user,
+            title="test1",
+            content="test1",
+            is_pinned=True,
+        )
+        self.assertEqual(thread.is_pinned, True)
+
+        Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test2", content="test2"
+        )
+
+        threads = Thread.objects.all()
+
+        self.assertEqual(threads[0], thread)
+
+    def test_bump(self):
+        thread1 = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test1", content="test1"
+        )
+        Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test2", content="test2"
+        )
+        Post.objects.create(thread=thread1, user=self.user, content="test1")
+        threads = Thread.objects.all()
+
+        self.assertEqual(threads[0], thread1)
+
     def test_get_absolute_url(self):
         thread = Thread.objects.create(
             subcategory=self.subcategory, user=self.user, title="test", content="test"
@@ -228,3 +288,459 @@ class ShoutTestCase(TestCase):
     def test_str(self):
         shout = Shout.objects.create(user=self.user, content="test")
         self.assertEqual(str(shout), f"{shout.user} > {shout.created_at}")
+
+
+class IndexViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.url = reverse("punkweb_bb:index")
+        self.user = User.objects.create(username="test", password="test")
+        self.staff_user = User.objects.create(
+            username="staff", password="staff", is_staff=True
+        )
+
+    def test_users_online(self):
+        response = self.client.get(self.url)
+        self.assertEqual(len(response.context["users_online"]), 0)
+
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(len(response.context["users_online"]), 1)
+
+    def test_staff_online(self):
+        response = self.client.get(self.url)
+        self.assertEqual(len(response.context["staff_online"]), 0)
+
+        self.client.force_login(self.staff_user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(len(response.context["staff_online"]), 1)
+
+    def test_newest_user(self):
+        response = self.client.get(self.url)
+        self.assertEqual(response.context["newest_user"], self.staff_user)
+
+    def test_users_count(self):
+        response = self.client.get(self.url)
+        self.assertEqual(response.context["users"].count(), 2)
+
+
+class LoginViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.url = reverse("punkweb_bb:login")
+        self.user = User.objects.create_user(username="test", password="test")
+
+    def test_redirect_authenticated_user(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, reverse("punkweb_bb:index"))
+
+    def test_login(self):
+        response = self.client.post(
+            self.url, {"username": "test", "password": "test"}, follow=True
+        )
+
+        self.assertRedirects(response, reverse("punkweb_bb:index"))
+        self.assertTrue(response.context["user"].is_authenticated)
+
+
+class LogoutViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.url = reverse("punkweb_bb:logout")
+        self.user = User.objects.create_user(username="test", password="test")
+
+    def test_logout(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url, follow=True)
+
+        self.assertRedirects(response, reverse("punkweb_bb:login"))
+        self.assertFalse(response.context["user"].is_authenticated)
+
+
+class SignupViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.url = reverse("punkweb_bb:signup")
+        self.user = User.objects.create_user(username="test1", password="test")
+
+    def test_redirect_authenticated_user(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, reverse("punkweb_bb:index"))
+
+    def test_signup(self):
+        response = self.client.post(
+            self.url,
+            {
+                "username": "test2",
+                "password1": "needsmorecomplexity",
+                "password2": "needsmorecomplexity",
+            },
+        )
+
+        self.assertRedirects(response, reverse("punkweb_bb:login"))
+
+
+class SettingsViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.url = reverse("punkweb_bb:settings")
+        self.user = User.objects.create_user(username="test", password="test")
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_settings(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        self.client.post(
+            self.url,
+            {
+                "signature": "[b]test[/b]",
+            },
+        )
+
+        self.user.profile.refresh_from_db()
+        self.assertEqual(self.user.profile._signature_rendered, "<strong>test</strong>")
+
+        self.assertEqual(response.status_code, 200)
+
+
+class ThreadCreateViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.staff_subcategory = Subcategory.objects.create(
+            name="staff", category=self.category, slug="staff", staff_post_only=True
+        )
+        self.url = reverse("punkweb_bb:thread_create", args=[self.subcategory.slug])
+        self.staff_only_url = reverse(
+            "punkweb_bb:thread_create", args=[self.staff_subcategory.slug]
+        )
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_thread_create(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.post(
+            self.url,
+            {
+                "title": "test",
+                "content": "test",
+            },
+            follow=True,
+        )
+
+        new_thread = Thread.objects.first()
+
+        self.assertRedirects(response, new_thread.get_absolute_url())
+        self.assertEqual(Thread.objects.count(), 1)
+        self.assertEqual(new_thread.user, self.user)
+        self.assertEqual(new_thread.subcategory, self.subcategory)
+
+    def test_thread_create_staff_post_only(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.staff_only_url)
+
+        self.assertRedirects(response, self.staff_subcategory.get_absolute_url())
+
+
+class ThreadViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.url = reverse("punkweb_bb:thread", args=[self.thread.id])
+
+    def test_view_count(self):
+        response = self.client.get(self.url)
+        self.assertEqual(response.context["thread"].view_count, 1)
+
+        # ensure that the view count does not increase when viewed again from the same session
+
+        response = self.client.get(self.url)
+        self.assertEqual(response.context["thread"].view_count, 1)
+
+
+class ThreadUpdateViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.other_user = User.objects.create_user(username="other", password="other")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.url = reverse("punkweb_bb:thread_update", args=[self.thread.id])
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_is_author(self):
+        self.client.force_login(self.other_user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 404)
+
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_thread_update(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.post(
+            self.url,
+            {
+                "title": "edit",
+                "content": "edit",
+            },
+            follow=True,
+        )
+
+        self.assertRedirects(response, self.thread.get_absolute_url())
+        self.thread.refresh_from_db()
+        self.assertEqual(self.thread.title, "edit")
+        self.assertEqual(self.thread._content_rendered, "edit")
+
+
+class ThreadDeleteViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.other_user = User.objects.create_user(username="other", password="other")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.url = reverse("punkweb_bb:thread_delete", args=[self.thread.id])
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_is_author(self):
+        self.client.force_login(self.other_user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 404)
+
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_thread_delete(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.delete(self.url, follow=True)
+
+        self.assertEqual(
+            response.headers["HX-Redirect"], self.subcategory.get_absolute_url()
+        )
+        self.assertEqual(Thread.objects.count(), 0)
+
+
+class PostCreateViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.url = reverse("punkweb_bb:post_create", args=[self.thread.id])
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_post_create(self):
+        self.client.force_login(self.user)
+
+        response = self.client.post(
+            self.url,
+            {
+                "content": "test",
+            },
+            follow=True,
+        )
+
+        new_post = Post.objects.first()
+
+        self.assertRedirects(response, new_post.get_absolute_url())
+        self.assertEqual(Post.objects.count(), 1)
+        self.assertEqual(new_post.user, self.user)
+        self.assertEqual(new_post.thread, self.thread)
+
+
+class PostUpdateViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.other_user = User.objects.create_user(username="other", password="other")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.post = Post.objects.create(
+            thread=self.thread, user=self.user, content="test"
+        )
+        self.url = reverse("punkweb_bb:post_update", args=[self.post.id])
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_is_author(self):
+        self.client.force_login(self.other_user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 404)
+
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_post_update(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.post(
+            self.url,
+            {
+                "content": "edit",
+            },
+            follow=True,
+        )
+
+        self.assertRedirects(response, self.post.get_absolute_url())
+        self.post.refresh_from_db()
+        self.assertEqual(self.post._content_rendered, "edit")
+
+
+class PostDeleteViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.other_user = User.objects.create_user(username="other", password="other")
+        self.category = Category.objects.create(name="test")
+        self.subcategory = Subcategory.objects.create(
+            name="test", category=self.category, slug="test"
+        )
+        self.thread = Thread.objects.create(
+            subcategory=self.subcategory, user=self.user, title="test", content="test"
+        )
+        self.post = Post.objects.create(
+            thread=self.thread, user=self.user, content="test"
+        )
+        self.url = reverse("punkweb_bb:post_delete", args=[self.post.id])
+
+    def test_redirect_unauthenticated_user(self):
+        response = self.client.get(self.url)
+
+        self.assertRedirects(response, f"{reverse('punkweb_bb:login')}?next={self.url}")
+
+    def test_is_author(self):
+        self.client.force_login(self.other_user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 404)
+
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_post_delete(self):
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.status_code, 200)
+
+        response = self.client.delete(self.url, follow=True)
+
+        self.assertEqual(
+            response.headers["HX-Redirect"], self.thread.get_absolute_url()
+        )
+        self.assertEqual(Post.objects.count(), 0)
+
+
+class ShoutCreateViewTestCase(TestCase):
+    def setUp(self):
+        self.client = Client()
+        self.user = User.objects.create_user(username="test", password="test")
+        self.url = reverse("punkweb_bb:shout_create")
+
+    def test_unauthenticated(self):
+        response = self.client.get(self.url)
+
+        self.client.post(
+            self.url,
+            {
+                "content": "test",
+            },
+        )
+
+        self.assertEqual(Shout.objects.count(), 0)
+        self.assertEqual(response.status_code, 200)
+
+    def test_shout_create(self):
+        self.client.force_login(self.user)
+
+        response = self.client.post(
+            self.url,
+            {
+                "content": "test",
+            },
+            follow=True,
+        )
+
+        self.assertEqual(Shout.objects.count(), 1)
+        self.assertEqual(response.status_code, 200)

punkweb_bb/views.py

@@ -108,7 +108,9 @@ def profile_view(request, user_id):
 
 
 def members_view(request):
-    users = paginate_qs(request, User.objects.select_related("profile").all())
+    users = paginate_qs(
+        request, User.objects.select_related("profile").order_by("username")
+    )
 
     context = {
         "users": users,
@@ -185,6 +187,13 @@ def thread_view(request, thread_id):
 
     post_form = PostModelForm()
 
+    # Increment view count if this session hasn't viewed the thread before
+    viewed_threads = request.session.get("viewed_threads", [])
+    if thread_id not in viewed_threads:
+        thread.view_count += 1
+        thread.save()
+        request.session["viewed_threads"] = viewed_threads + [thread_id]
+
     context = {
         "thread": thread,
         "posts": posts,
@@ -235,7 +244,7 @@ def post_create_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)
 
     if thread.is_closed:
-        return HttpResponseForbidden("This thread is closed.")
+        return HttpResponseForbidden("Cannot add posts to a closed thread.")
 
     form = PostModelForm(request.POST)
 
@@ -336,7 +345,7 @@ def bbcode_view(request):
         ("Url", "[url=https://google.com]Link Text[/url]"),
         (
             "Image",
-            "[img]https://punkweb.net/media/music/artists/system-lynx_EklOGpj.png.200x200_q85_crop.png[/img]",
+            "[img]https://placehold.co/400[/img]",
         ),
         # Custom
         ("Horizontal Rule", "[hr]"),

punkweb_bb-0.1.3.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: punkweb-bb
+Version: 0.1.3
+Summary: Django application that provides a simple and modern forum board software for your Django website.
+Home-page: https://github.com/Punkweb/PunkwebBB
+Author: Punkweb
+Author-email: punkwebnet@gmail.com
+License: BSD-3-Clause
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django >=4.0
+Requires-Dist: django-precise-bbcode
+Requires-Dist: pillow
+
+# PunkwebBB
+
+PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
+
+This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards).
+
+Check out [punkweb.net](https://punkweb.net/board/) for a live demo and more information!
+
+## Built with
+
+- [Django](https://www.djangoproject.com/)
+- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
+- [HTMX](https://htmx.org/)
+- [jQuery](https://jquery.com/)
+- [SCEditor](https://www.sceditor.com/)
+- [PrismJS](https://prismjs.com/)
+
+## Requirements
+
+- Python 3.11+
+- Django 4.2+
+- django-precise-bbcode 1.2+
+- Pillow
+
+It may work with older versions of Python and Django, but it has not been tested.
+
+## Installation
+
+```bash
+pip install punkweb-bb
+```
+
+Add `precise_bbcode` and `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
+
+```python
+INSTALLED_APPS = [
+    ...
+    "precise_bbcode",
+    "punkweb_bb",
+]
+```
+
+_Note_: `precise_bbcode` is required. It must be installed before `punkweb_bb`.
+
+Add the following middleware to your `MIDDLEWARE` setting:
+
+```python
+MIDDLEWARE = [
+    ...
+    "punkweb_bb.middleware.ProfileOnlineCacheMiddleware",
+]
+```
+
+Add the following context processor to your `TEMPLATES` setting:
+
+```python
+TEMPLATES = [
+    {
+        ...
+        "OPTIONS": {
+            "context_processors": [
+                ...
+                "punkweb_bb.context_processors.punkweb_bb",
+            ],
+        },
+    },
+]
+```
+
+Add the following URL pattern to your `urls.py`:
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    ...
+    path("forum/", include("punkweb_bb.urls")), # or any other path you want
+]
+```
+
+And finally, install the models:
+
+```bash
+python manage.py migrate
+```
+
+## Configuration
+
+These are the default settings for PunkwebBB, which can be overridden in your Django settings module:
+
+```python
+PUNKWEB_BB = {
+  "SITE_NAME": "PUNKWEB",
+  "SITE_TITLE": "PunkwebBB",
+  "FAVICON": "punkweb_bb/favicon.ico",
+  "SHOUTBOX_ENABLED": True,
+}
+```
+
+## Testing
+
+Report:
+
+```bash
+coverage run && coverage report
+```
+
+HTML:
+
+```bash
+coverage run && coverage html
+```
+
+```bash
+Found 57 test(s).
+Creating test database for alias 'default'...
+System check identified no issues (0 silenced).
+.........................................................
+----------------------------------------------------------------------
+Ran 57 tests in 8.824s
+
+OK
+Destroying test database for alias 'default'...
+Name                                         Stmts   Miss  Cover
+----------------------------------------------------------------
+punkweb_bb/__init__.py                           0      0   100%
+punkweb_bb/admin.py                             41      1    98%
+punkweb_bb/admin_forms.py                       28      0   100%
+punkweb_bb/apps.py                               6      0   100%
+punkweb_bb/bbcode_tags.py                      115      3    97%
+punkweb_bb/context_processors.py                 3      0   100%
+punkweb_bb/forms.py                             35      0   100%
+punkweb_bb/middleware.py                        10      0   100%
+punkweb_bb/mixins.py                            11      0   100%
+punkweb_bb/models.py                           124      0   100%
+punkweb_bb/pagination.py                        11      4    64%
+punkweb_bb/parsers.py                           50      2    96%
+punkweb_bb/response.py                           3      0   100%
+punkweb_bb/settings.py                           6      0   100%
+punkweb_bb/signals.py                            9      0   100%
+punkweb_bb/templatetags/__init__.py              0      0   100%
+punkweb_bb/templatetags/humanize_int.py          9      5    44%
+punkweb_bb/templatetags/shoutbox_bbcode.py       9      0   100%
+punkweb_bb/tests.py                            410      0   100%
+punkweb_bb/urls.py                               4      0   100%
+punkweb_bb/views.py                            174     17    90%
+punkweb_bb/widgets.py                            8      0   100%
+----------------------------------------------------------------
+TOTAL                                         1066     32    97%
+```

{punkweb_bb-0.1.2.dist-info → punkweb_bb-0.1.3.dist-info}/RECORD

@@ -7,15 +7,15 @@ punkweb_bb/context_processors.py,sha256=BEOGvWVukvxJUxWZBIc32ioB-mGqImSEBuhhZjqI
 punkweb_bb/forms.py,sha256=O1lzmgumdnSEjBKi10c7ODftIqRmvtEIdNj1IODCikk,1977
 punkweb_bb/middleware.py,sha256=lF1w7XM07s1kcrOWodzErHop9zpIE5SEE52YLMAbDKg,456
 punkweb_bb/mixins.py,sha256=XfiThPL7rB71IfukS1ikvYQhfg8RwgSVgsm10Ul1ezM,395
-punkweb_bb/models.py,sha256=DZ6DrnRVGbb8Zb5LL9Q2571YDg-0X2_LoBsRhg2J7sg,5314
+punkweb_bb/models.py,sha256=Y5w80EQ85Mut71xiDVMALqLXdydlTxOiZEljmnH5g-E,5519
 punkweb_bb/pagination.py,sha256=OgoZuJsq9MKMvBKYylJVPaNtM9ni3K8OAvOdi-eGr3M,409
 punkweb_bb/parsers.py,sha256=VjWSPqpVfypHLHP0NrfLqXB-1b0W6oFuGIzoAiPi71I,2732
 punkweb_bb/response.py,sha256=dETGVC9Xrsq02pQzmIIWbSUt472lJ4fgLwBKrXnP3t4,130
-punkweb_bb/settings.py,sha256=kC0jwMkKNtmpBopSagYUe_lVKu-EEzLORr63aouuXGI,250
+punkweb_bb/settings.py,sha256=rYKMQxbC6rfzOQgcjAoBuMEgKHOITvOX1PrKTweEYKk,312
 punkweb_bb/signals.py,sha256=bVdfg942Mwq-fYDZ1Z52Q0V2BCk1lgzGz8JVZFPnzJ8,365
-punkweb_bb/tests.py,sha256=uCYeK5EQ2bCudge0gOUrDWdBcsx3fYFv6iSgdyjtL5k,8257
+punkweb_bb/tests.py,sha256=BXkvqtr1JbE2WQYkgjse3wp9ky3cwOzQcVHoqNhHJmw,25989
 punkweb_bb/urls.py,sha256=_mRAtaZoKzPZ_uuOCFy6_lOwFCavv26p5kMKD9MH4c4,1538
-punkweb_bb/views.py,sha256=dievICp0o9U-NCJDguW959e5RFf3NDEBfL97aYD-PYw,10435
+punkweb_bb/views.py,sha256=HDJCM8PgDkQu96UbZLFyjSD2K9WIjLhWEO-QBM3APmk,10723
 punkweb_bb/widgets.py,sha256=eF6CB5nnh_6XJadpDzDKgd9incd0VIR63Rnzdr8T2n0,840
 punkweb_bb/__pycache__/__init__.cpython-311.pyc,sha256=3PyxCxoznfadaGt0a7re4j0Ky9z9hblufpcwPB85kK8,161
 punkweb_bb/__pycache__/admin.cpython-311.pyc,sha256=rAPYqRy7hAVZn3qST3ypYdulvH9IBhzWEgvbbAMIMIY,3679
@@ -26,18 +26,21 @@ punkweb_bb/__pycache__/context_processors.cpython-311.pyc,sha256=P7rEsodXonYexbS
 punkweb_bb/__pycache__/forms.cpython-311.pyc,sha256=JRbtAaXyXgG9eDdBjKBkSn8qeZtdxRc7L2_ceE-MpW8,4680
 punkweb_bb/__pycache__/middleware.cpython-311.pyc,sha256=gZN0oVrPh9nIUUni_DvPrhMOYPR98SXrYxgHIsUXX-0,1249
 punkweb_bb/__pycache__/mixins.cpython-311.pyc,sha256=eP1NjqDNYMYXrC45DNkrTqVAUv1vsGBrqPy5U5CB_aw,1478
-punkweb_bb/__pycache__/models.cpython-311.pyc,sha256=PrebadNmOX3Ra3tRXhxU26E284LAHJhERXvgyTXXtow,12034
+punkweb_bb/__pycache__/models.cpython-311.pyc,sha256=9W03p0j5_dYnQ4YffZUrN_A5-Bvkbpvfmpr5rOkzyAQ,12308
 punkweb_bb/__pycache__/pagination.cpython-311.pyc,sha256=r54xmtiRp5dm1n2Xa7oElMFFaYFY0RzmMuF3Er4UqEA,990
 punkweb_bb/__pycache__/parsers.cpython-311.pyc,sha256=pp8JZt9V3HhquQMGrhglwLc53GxgNFWjjSnK3Bpxf8o,5335
 punkweb_bb/__pycache__/response.cpython-311.pyc,sha256=CEPckYWZkOrdU2Vow-ni0ZrWEUBww0uJzyr_wv---mM,448
-punkweb_bb/__pycache__/settings.cpython-311.pyc,sha256=lGhRUWwPQlXSfwFB5FlMvydr14_IaB7Gd2CXuLLVwrI,563
+punkweb_bb/__pycache__/settings.cpython-311.pyc,sha256=ZjE994_MuSW_9Dn_ufsUH-vrld-BvqEwoCF7YL9tbrA,665
 punkweb_bb/__pycache__/signals.cpython-311.pyc,sha256=AHChn7hDdrOmCAwKIKKuFOY-4hyBP9uwTkyb5bnFV-Q,864
+punkweb_bb/__pycache__/tests.cpython-311.pyc,sha256=3CM8FL8P1YXVcgShhXqXjg3Yo3T1amKXlVtHRUZ2d7o,50877
 punkweb_bb/__pycache__/urls.cpython-311.pyc,sha256=80TvNUws6ip1FCts6bubO3DGQJ2yOlB-WReK-qaTnGY,2304
-punkweb_bb/__pycache__/views.cpython-311.pyc,sha256=7myiqdsURN68OLr94FjW_75Xxt9G85yX80qn52hMDS4,15313
+punkweb_bb/__pycache__/views.cpython-311.pyc,sha256=bjqhbTnN0-pvIygCzh0NXY6lNJUjMpz8B51EIlpay94,15592
 punkweb_bb/__pycache__/widgets.cpython-311.pyc,sha256=-RcQ3JapLHw8Bbi4FP05kQJJIa7bnliKPaFpkDCOWvQ,1552
 punkweb_bb/migrations/0001_initial.py,sha256=3RGsylygBcWx1kIPhSzOb9v_2yvowsxKfxuSinKKuS0,8950
+punkweb_bb/migrations/0002_thread_view_count.py,sha256=JJZT53Mp8Ofht3oIi67s-0wzCdpYyu8wOeCi_B8q8Yo,388
 punkweb_bb/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 punkweb_bb/migrations/__pycache__/0001_initial.cpython-311.pyc,sha256=koi_VflndmTKzSXWstWBXuVEZgEeueId5NE4kOAlA4Q,6456
+punkweb_bb/migrations/__pycache__/0002_thread_view_count.cpython-311.pyc,sha256=9HRllkD8LHPXadyurYvp2UcmRFEywalUVQjiOGWizgc,815
 punkweb_bb/migrations/__pycache__/__init__.cpython-311.pyc,sha256=sTbC1AXnh0V4BJwjcjs1ckdeYjG01I348hZwLE2HI4Y,172
 punkweb_bb/static/punkweb_bb/favicon.ico,sha256=lEfX--R9wEGPkkXgLYCsGmHuAGajigiqBXAoonxq8ZM,318
 punkweb_bb/static/punkweb_bb/css/defaults.css,sha256=EsYORpHIQ8gotAdiGvBBU38i6F0mICj-OKr-JF6yYVg,1455
@@ -45,7 +48,7 @@ punkweb_bb/static/punkweb_bb/css/index.css,sha256=NqpF7zNMzSrDeHw5gfbwcmeBET4TcS
 punkweb_bb/static/punkweb_bb/css/login.css,sha256=pt5ul4ycZsVB-No3c5gsQa1zVS1iAZgteN1CcllS26k,234
 punkweb_bb/static/punkweb_bb/css/members.css,sha256=1Fz0uVDbs3RnuXNjOtnGnK2jok3LEQBoPhjRYp7gNwE,395
 punkweb_bb/static/punkweb_bb/css/post-form.css,sha256=rEiYplAobLjjUYAcnjNqIjyIVhe9O5hAlPJ3STW-K14,321
-punkweb_bb/static/punkweb_bb/css/profile.css,sha256=2guoiUHk8LbCZbZtzp4OrWTbMFfsiiNPzXeI4FPv3MY,799
+punkweb_bb/static/punkweb_bb/css/profile.css,sha256=yfNJT_D-05deqiBrdIgPeCSO_DFSL8-fGEEHnGrCIYM,916
 punkweb_bb/static/punkweb_bb/css/punkweb-modal.css,sha256=ctwo5bgbAW-k0uqrufDbqeQfAh87-BZ-5gPm8aJHeT4,1296
 punkweb_bb/static/punkweb_bb/css/punkweb.css,sha256=UZT592v_krB8DPFf6YN1zlKmmFiCAXdS_KqO98GrKNM,11284
 punkweb_bb/static/punkweb_bb/css/settings.css,sha256=ulQQFTu8slk2rYOmhvci5v-AVnguUuDhKQDhyQOsQNU,308
@@ -185,7 +188,7 @@ punkweb_bb/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/office-toolba
 punkweb_bb/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/office.min.css,sha256=EZeNIT-LMxAnrW_7M6BXuH0B8m3MoIS68tDyTxmCoP0,13148
 punkweb_bb/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/square.min.css,sha256=vrNHEnpQJr3o8AlJ2aEhn4fsRqR4TOopE3N3-4oE2ho,10710
 punkweb_bb/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/content/default.min.css,sha256=2jMxGiqcrAhfOtNMdqmTUtfgM6oUz5F0VJ0sUzam9CY,1016
-punkweb_bb/templates/punkweb_bb/base.html,sha256=Hk1yL0tPRBpNWZ2A3WmItmwh3kxtVjaLM95jrklxizk,4034
+punkweb_bb/templates/punkweb_bb/base.html,sha256=Gu2ZVeP0p7GnsfXFxByXRd9LT4DNXx0O1czSGjwYg0w,4037
 punkweb_bb/templates/punkweb_bb/base_modal.html,sha256=OCbtsMWeNCO0Tl1PmHCcGkwoi1OZjeIK_VhNTzMor7M,460
 punkweb_bb/templates/punkweb_bb/bbcode.html,sha256=1EGBejsOMZOPi6P39oR6E35VdqnfR6wYWeKDl4Xr_js,396
 punkweb_bb/templates/punkweb_bb/index.html,sha256=2y8gS6UzoJkVXvmw5PEuuxyYIarlNjGzTmmNMuNWNJ8,8127
@@ -194,21 +197,24 @@ punkweb_bb/templates/punkweb_bb/members.html,sha256=ceRCRX0AN7V8d7paz9495y8aQByM
 punkweb_bb/templates/punkweb_bb/profile.html,sha256=MW1JWLs_lLpg62DDcvcZJRwrHquYA5nCwQqL1v9ZGCo,2948
 punkweb_bb/templates/punkweb_bb/settings.html,sha256=CmmGdNddZj6Atpofcny0bwEHwTPRPC8vXXThCgsNH90,1994
 punkweb_bb/templates/punkweb_bb/signup.html,sha256=HP5owUfV2uEuvOccPoBa21XbjBHo0ulV6tjfgdToNLU,1167
-punkweb_bb/templates/punkweb_bb/subcategory.html,sha256=S5DCrYYYdU3DbTpsyscbvCDFYSaDIkRqu2Mxy8NIQpo,4682
-punkweb_bb/templates/punkweb_bb/thread.html,sha256=CcHK1XfuYxUGyFBP19_45xeeHc3JNqGDvj1Vj4Yp4u0,7457
-punkweb_bb/templates/punkweb_bb/thread_create.html,sha256=HcjiJvP2keytgwFrONtOkS2yGaOT1o4i5fCJgndocpc,1399
-punkweb_bb/templates/punkweb_bb/thread_update.html,sha256=HzTGHCzV-v1B743vC-dQ72eg--UBrpPbqSVP_aN_9oc,1578
+punkweb_bb/templates/punkweb_bb/subcategory.html,sha256=rLJtBKz2Zd07Lyan6fH2fn7i8bXyfVj9hpnBh6m3PS4,4950
+punkweb_bb/templates/punkweb_bb/thread.html,sha256=igyEa1Qz-joktKmUbgHtIY0EnxlWUCBHDdEXNTuKJDk,7595
+punkweb_bb/templates/punkweb_bb/thread_create.html,sha256=rLIO-ghdzHCiKJ6LCj2l4cxe9QbsMUG13ZxogYF9PUE,1537
+punkweb_bb/templates/punkweb_bb/thread_update.html,sha256=SLL_5tceZ8ZiPbWCO9eOe_aeMgV5lQ-p6eun1_XvKwE,1730
 punkweb_bb/templates/punkweb_bb/partials/post_delete.html,sha256=tQtQGxTF0tZA5eXqfIuO6NctsS83eEhR4ImmBLbkAXM,417
 punkweb_bb/templates/punkweb_bb/partials/post_update.html,sha256=mFidDqgTuv4LffuSa8pShXxWmiramLLMhHjsaJs1Y9k,565
 punkweb_bb/templates/punkweb_bb/partials/thread_delete.html,sha256=m91u_r8qTvMqR2s4VxxFHQvZt-WGgHnHzJL_1KZkX9M,425
 punkweb_bb/templates/punkweb_bb/shoutbox/shout_list.html,sha256=uAls--UuLgS6NPW2qEsNbutR_aoJ_AuhZ_Fkt-c8ipU,312
 punkweb_bb/templates/punkweb_bb/shoutbox/shoutbox.html,sha256=J_Lp6KKcqSJr-IayyLN-p0JgMfuwbFP77g-UtcM53WI,672
 punkweb_bb/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+punkweb_bb/templatetags/humanize_int.py,sha256=C4KmDG0Jv6o8rwT1RXLdWoGLddJxMxgOoRV9I2598AM,248
 punkweb_bb/templatetags/shoutbox_bbcode.py,sha256=OH-FsRTyPWZldaFypSVzPLlTrSm4XEOqQW9hBI0ROBk,310
-punkweb_bb/templatetags/__pycache__/__init__.cpython-311.pyc,sha256=hieh5xV9m_aA6xLQJ86ABc9pnKF0MnAxwvly-pwYSDo,174
+punkweb_bb/templatetags/__pycache__/__init__.cpython-311.pyc,sha256=VEPKwaIhqpKpSSJiotDYngAUdidDzR9PpPiHtKEl1jA,174
+punkweb_bb/templatetags/__pycache__/humanize_count.cpython-311.pyc,sha256=UKD6_5RX8YpYpg-LPrgGxBkW56THsbYY51cKTYdKwRY,621
+punkweb_bb/templatetags/__pycache__/humanize_int.cpython-311.pyc,sha256=csY5ek-bevYVeM91hYFKozuKWXCTXb7M-7Bokwdxhrk,619
 punkweb_bb/templatetags/__pycache__/shoutbox_bbcode.cpython-311.pyc,sha256=Jhg9qW-nQe6IDr45rE0ZgeDYF4E61S7kYAYpbMo5ZQ8,833
-punkweb_bb-0.1.2.dist-info/LICENSE,sha256=YYysF07B-kyXSO7IWFB9f49ZXa6LIFUTVsR1Ogmhp8s,1507
-punkweb_bb-0.1.2.dist-info/METADATA,sha256=ckMonMRB6vfDo-XWU_tetw_v8fiwQTwZxeGrxQ1Uuug,1797
-punkweb_bb-0.1.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-punkweb_bb-0.1.2.dist-info/top_level.txt,sha256=sWuGdGnk0ejOXiFDzlBqrNs2VbPEx0_i8UwWXn4SuHU,11
-punkweb_bb-0.1.2.dist-info/RECORD,,
+punkweb_bb-0.1.3.dist-info/LICENSE,sha256=YYysF07B-kyXSO7IWFB9f49ZXa6LIFUTVsR1Ogmhp8s,1507
+punkweb_bb-0.1.3.dist-info/METADATA,sha256=thU9kjReWNpjs73xcTkXgnO0LKX_-g_wELf87WiE-0Q,4930
+punkweb_bb-0.1.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+punkweb_bb-0.1.3.dist-info/top_level.txt,sha256=sWuGdGnk0ejOXiFDzlBqrNs2VbPEx0_i8UwWXn4SuHU,11
+punkweb_bb-0.1.3.dist-info/RECORD,,

punkweb_bb-0.1.2.dist-info/METADATA

@@ -1,72 +0,0 @@
-Metadata-Version: 2.1
-Name: punkweb-bb
-Version: 0.1.2
-Summary: Django application that provides a simple and modern forum board software for your Django website.
-Home-page: https://github.com/Punkweb/PunkwebBB
-Author: Punkweb
-Author-email: punkwebnet@gmail.com
-License: BSD-3-Clause
-Classifier: Environment :: Web Environment
-Classifier: Framework :: Django
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: django >=4.0
-Requires-Dist: django-precise-bbcode
-Requires-Dist: pillow
-
-# PunkwebBB
-
-PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
-
-This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards)
-
-## Built with
-
-- [Django](https://www.djangoproject.com/)
-- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
-- [HTMX](https://htmx.org/)
-- [jQuery](https://jquery.com/)
-- [SCEditor](https://www.sceditor.com/)
-- [PrismJS](https://prismjs.com/)
-
-## Requirements
-
-- Python 3.11+
-- Django 4.2+
-- django-precise-bbcode 1.2+
-- Pillow
-
-It may work with older versions of Python and Django, but it has not been tested.
-
-## Testing
-
-Report:
-
-```bash
-coverage run && coverage report
-```
-
-HTML:
-
-```bash
-coverage run && coverage html
-```
-
-## Preview
-
-#### Models
-
-![Models](https://github.com/Punkweb/PunkwebBB/blob/main/images/models.png)
-
-#### Index View
-
-![Index](https://github.com/Punkweb/PunkwebBB/blob/main/images/index.png)
-
-#### Thread View
-
-![Thread](https://github.com/Punkweb/PunkwebBB/blob/main/images/thread.png)