punkweb-bb 0.1.2__tar.gz → 0.1.4__tar.gz

punkweb_bb-0.1.4/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: punkweb_bb
+Version: 0.1.4
+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
+
+# 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,
+  "DISCORD_WIDGET_ENABLED": False,
+  "DISCORD_WIDGET_THEME": "dark",
+  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
+}
+```
+
+## 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.4/README.md

@@ -0,0 +1,153 @@
+# 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,
+  "DISCORD_WIDGET_ENABLED": False,
+  "DISCORD_WIDGET_THEME": "dark",
+  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
+}
+```
+
+## 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.4/punkweb_bb/guests.py

@@ -0,0 +1,20 @@
+from expiringdict import ExpiringDict
+
+
+class GuestList:
+    def __init__(self):
+        self.__guests = ExpiringDict(max_len=2048, max_age_seconds=60 * 5)
+
+    def length(self):
+        return len(self.__guests)
+
+    def add(self, ip):
+        if not self.__guests.get(ip, None):
+            self.__guests[ip] = True
+
+    def clear_expired(self):
+        for key in list(self.__guests.keys()):
+            _ = self.__guests.get(key, None)
+
+
+guest_list = GuestList()

{punkweb_bb-0.1.2 → punkweb_bb-0.1.4}/punkweb_bb/middleware.py

@@ -1,6 +1,8 @@
 from django.core.cache import cache
 from django.utils import timezone
 
+from punkweb_bb.guests import guest_list
+
 
 class ProfileOnlineCacheMiddleware:
     def __init__(self, get_response):
@@ -11,6 +13,11 @@ class ProfileOnlineCacheMiddleware:
             cache.set(
                 f"profile_online_{request.user.profile.id}", timezone.now(), 60 * 5
             )
+        else:
+            ip = request.META.get("REMOTE_ADDR")
+            guest_list.add(ip)
+
+        guest_list.clear_expired()
 
         response = self.get_response(request)
 

punkweb_bb-0.1.4/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-0.1.2 → punkweb_bb-0.1.4}/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-0.1.4/punkweb_bb/settings.py

@@ -0,0 +1,11 @@
+from django.conf import settings
+
+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)
+DISCORD_WIDGET_ENABLED = PUNKWEB_BB.get("DISCORD_WIDGET_ENABLED", False)
+DISCORD_WIDGET_THEME = PUNKWEB_BB.get("DISCORD_WIDGET_THEME", "dark")
+DISCORD_SERVER_ID = PUNKWEB_BB.get("DISCORD_SERVER_ID", None)

{punkweb_bb-0.1.2 → punkweb_bb-0.1.4}/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-0.1.2 → punkweb_bb-0.1.4}/punkweb_bb/static/punkweb_bb/css/punkweb.css

@@ -646,3 +646,26 @@ blockquote cite {
 .pw-breadcrumb-item.active {
   color: var(--breadcrumb-active);
 }
+
+/* Callout */
+
+.pw-callout {
+  background-color: var(--oc-gray-1);
+  border: 1px solid var(--border);
+  border-radius: 0.25rem;
+  color: var(--oc-gray-9);
+  padding: 0.5rem 1rem;
+  width: 100%;
+}
+
+.pw-callout.primary {
+  background-color: var(--primary-0);
+  border-color: 1px solid var(--primary-4);
+  color: var(--primary-9);
+}
+
+.pw-callout.danger {
+  background-color: var(--oc-red-0);
+  border-color: 1px solid var(--oc-red-4);
+  color: var(--oc-red-9);
+}

{punkweb_bb-0.1.2 → punkweb_bb-0.1.4}/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-0.1.2 → punkweb_bb-0.1.4}/punkweb_bb/templates/punkweb_bb/index.html

@@ -171,16 +171,29 @@
             </div>
             {% endif %}
             <div class="index__statistics__row">
-              <div class="index__statistics__label">Members online:</div>
-              <div class="index__statistics__value">{{users_online|length}}</div>
-            </div>
-            <div class="index__statistics__row">
-              <div class="index__statistics__label">Staff online:</div>
-              <div class="index__statistics__value">{{staff_online|length}}</div>
+              <div class="index__statistics__label">Users online:</div>
+              <div class="index__statistics__value">{{total_online}} ({{members_online|length}} members, {{staff_online|length}} staff, {{guests_online}} guests)</div>
             </div>
           </div>
         </div>
       </div>
+      {% if punkweb_bb.settings.DISCORD_WIDGET_ENABLED %}
+      {% if punkweb_bb.settings.DISCORD_SERVER_ID %}
+      <iframe
+        src="https://discord.com/widget?id={{ punkweb_bb.settings.DISCORD_SERVER_ID }}&theme={{ punkweb_bb.settings.DISCORD_WIDGET_THEME|default:'dark' }}"
+        width="100%"
+        height="384"
+        allowtransparency="true"
+        frameborder="0"
+        sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts">
+      </iframe>
+      {% else %}
+      <div class="pw-callout danger">
+        <h4>Discord Widget Error</h4>
+        <p><code>DISCORD_SERVER_ID</code> not configured in settings module.</p>
+      </div>
+      {% endif %}
+      {% endif %}
     </div>
   </div>
 </div>

{punkweb_bb-0.1.2 → punkweb_bb-0.1.4}/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-0.1.2 → punkweb_bb-0.1.4}/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-0.1.2 → punkweb_bb-0.1.4}/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-0.1.2 → punkweb_bb-0.1.4}/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-0.1.4/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