punkweb-bb 0.2.3__tar.gz → 0.3.0__tar.gz

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb_bb
-Version: 0.2.3
+Version: 0.3.0
 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
@@ -28,20 +28,35 @@ Check out [punkweb.net](https://punkweb.net/board/) for documentation, support a
 
 - [Django](https://www.djangoproject.com/)
 - [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
+- [Markdown](https://python-markdown.github.io/)
 - [HTMX](https://htmx.org/)
 - [jQuery](https://jquery.com/)
 - [SCEditor](https://www.sceditor.com/)
+- [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
 
 ## Requirements
 
 - Python 3.9+
-- Django 4.2+
+- Django 4.0+
 - django-precise-bbcode 1.2+
+- markdown 3.6+
 - Pillow
 
 It may work with older versions of Python and Django, but it has not been tested.
 
+## BBCode or Markdown?
+
+PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which renderer you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
+
+BBCode is the default renderer, but you can switch to Markdown by setting the following in your Django settings module:
+
+```python
+PUNKWEB_BB = {
+  "RENDERER": "markdown",
+}
+```
+
 ## Installation
 
 ```bash
@@ -58,16 +73,7 @@ INSTALLED_APPS = [
 ]
 ```
 
-_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",
-]
-```
+_Note_: `precise_bbcode` is required even if using the Markdown renderer! It must be installed before `punkweb_bb`.
 
 Add the following context processor to your `TEMPLATES` setting:
 
@@ -110,6 +116,7 @@ These are the default settings for PunkwebBB, which can be overridden in your Dj
 PUNKWEB_BB = {
   "SITE_NAME": "PUNKWEB",
   "SITE_TITLE": "PunkwebBB",
+  "RENDERER": "bbcode", # "bbcode" or "markdown"
   "FAVICON": "punkweb_bb/favicon.ico",
   "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
   "SHOUTBOX_ENABLED": True,
@@ -134,39 +141,46 @@ coverage run && coverage html
 ```
 
 ```bash
-Found 57 test(s).
+Found 59 test(s).
 Creating test database for alias 'default'...
 System check identified no issues (0 silenced).
-.........................................................
+...........................................................
 ----------------------------------------------------------------------
-Ran 57 tests in 8.824s
+Ran 59 tests in 9.166s
 
 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%
+Name                                           Stmts   Miss  Cover
+------------------------------------------------------------------
+punkweb_bb/__init__.py                             0      0   100%
+punkweb_bb/admin.py                               43      0   100%
+punkweb_bb/admin_forms.py                         34      0   100%
+punkweb_bb/apps.py                                 6      0   100%
+punkweb_bb/context_processors.py                   3      0   100%
+punkweb_bb/forms.py                               47      0   100%
+punkweb_bb/guests.py                              13      0   100%
+punkweb_bb/middleware.py                          14      0   100%
+punkweb_bb/mixins.py                              11      0   100%
+punkweb_bb/models.py                             153      1    99%
+punkweb_bb/pagination.py                          11      4    64%
+punkweb_bb/parsers.py                             50     36    28%
+punkweb_bb/response.py                             3      0   100%
+punkweb_bb/settings.py                            11      0   100%
+punkweb_bb/signals.py                              9      0   100%
+punkweb_bb/templatetags/__init__.py                0      0   100%
+punkweb_bb/templatetags/can_delete.py              5      0   100%
+punkweb_bb/templatetags/can_edit.py                5      0   100%
+punkweb_bb/templatetags/can_post.py                5      0   100%
+punkweb_bb/templatetags/humanize_int.py            9      5    44%
+punkweb_bb/templatetags/render.py                 36     12    67%
+punkweb_bb/templatetags/shoutbox_render.py        18      2    89%
+punkweb_bb/templatetags/styled_group_name.py       7      1    86%
+punkweb_bb/templatetags/styled_username.py         6      0   100%
+punkweb_bb/tests.py                              418      0   100%
+punkweb_bb/urls.py                                 4      0   100%
+punkweb_bb/utils.py                               42     24    43%
+punkweb_bb/views.py                              304    118    61%
+punkweb_bb/widgets.py                             16      0   100%
+------------------------------------------------------------------
+TOTAL                                           1283    203    84%
 ```

punkweb_bb-0.3.0/README.md

@@ -0,0 +1,168 @@
+# 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 documentation, support and a live demonstration of the software.
+
+## Built with
+
+- [Django](https://www.djangoproject.com/)
+- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
+- [Markdown](https://python-markdown.github.io/)
+- [HTMX](https://htmx.org/)
+- [jQuery](https://jquery.com/)
+- [SCEditor](https://www.sceditor.com/)
+- [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
+- [PrismJS](https://prismjs.com/)
+
+## Requirements
+
+- Python 3.9+
+- Django 4.0+
+- django-precise-bbcode 1.2+
+- markdown 3.6+
+- Pillow
+
+It may work with older versions of Python and Django, but it has not been tested.
+
+## BBCode or Markdown?
+
+PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which renderer you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
+
+BBCode is the default renderer, but you can switch to Markdown by setting the following in your Django settings module:
+
+```python
+PUNKWEB_BB = {
+  "RENDERER": "markdown",
+}
+```
+
+## 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 even if using the Markdown renderer! It must be installed before `punkweb_bb`.
+
+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",
+  "RENDERER": "bbcode", # "bbcode" or "markdown"
+  "FAVICON": "punkweb_bb/favicon.ico",
+  "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
+  "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 59 test(s).
+Creating test database for alias 'default'...
+System check identified no issues (0 silenced).
+...........................................................
+----------------------------------------------------------------------
+Ran 59 tests in 9.166s
+
+OK
+Destroying test database for alias 'default'...
+Name                                           Stmts   Miss  Cover
+------------------------------------------------------------------
+punkweb_bb/__init__.py                             0      0   100%
+punkweb_bb/admin.py                               43      0   100%
+punkweb_bb/admin_forms.py                         34      0   100%
+punkweb_bb/apps.py                                 6      0   100%
+punkweb_bb/context_processors.py                   3      0   100%
+punkweb_bb/forms.py                               47      0   100%
+punkweb_bb/guests.py                              13      0   100%
+punkweb_bb/middleware.py                          14      0   100%
+punkweb_bb/mixins.py                              11      0   100%
+punkweb_bb/models.py                             153      1    99%
+punkweb_bb/pagination.py                          11      4    64%
+punkweb_bb/parsers.py                             50     36    28%
+punkweb_bb/response.py                             3      0   100%
+punkweb_bb/settings.py                            11      0   100%
+punkweb_bb/signals.py                              9      0   100%
+punkweb_bb/templatetags/__init__.py                0      0   100%
+punkweb_bb/templatetags/can_delete.py              5      0   100%
+punkweb_bb/templatetags/can_edit.py                5      0   100%
+punkweb_bb/templatetags/can_post.py                5      0   100%
+punkweb_bb/templatetags/humanize_int.py            9      5    44%
+punkweb_bb/templatetags/render.py                 36     12    67%
+punkweb_bb/templatetags/shoutbox_render.py        18      2    89%
+punkweb_bb/templatetags/styled_group_name.py       7      1    86%
+punkweb_bb/templatetags/styled_username.py         6      0   100%
+punkweb_bb/tests.py                              418      0   100%
+punkweb_bb/urls.py                                 4      0   100%
+punkweb_bb/utils.py                               42     24    43%
+punkweb_bb/views.py                              304    118    61%
+punkweb_bb/widgets.py                             16      0   100%
+------------------------------------------------------------------
+TOTAL                                           1283    203    84%
+```

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/admin.py

@@ -34,10 +34,6 @@ class BoardProfileModelAdmin(admin.ModelAdmin):
         "user__username",
         "user__email",
     )
-    readonly_fields = ("signature_rendered",)
-
-    def signature_rendered(self, obj):
-        return mark_safe(obj.signature.rendered)
 
 
 @admin.register(Category)

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/admin_forms.py

@@ -8,6 +8,7 @@ from punkweb_bb.models import (
     Subcategory,
     Thread,
 )
+from punkweb_bb.utils import get_editor_widget
 from punkweb_bb.widgets import BBCodeEditorWidget
 
 
@@ -16,7 +17,7 @@ class BoardProfileAdminModelForm(forms.ModelForm):
         model = BoardProfile
         fields = "__all__"
         widgets = {
-            "signature": BBCodeEditorWidget(),
+            "signature": get_editor_widget(),
         }
 
 
@@ -25,7 +26,7 @@ class CategoryAdminModelForm(forms.ModelForm):
         model = Category
         fields = "__all__"
         widgets = {
-            "description": BBCodeEditorWidget(),
+            "description": get_editor_widget(),
         }
 
 
@@ -34,7 +35,7 @@ class SubcategoryAdminModelForm(forms.ModelForm):
         model = Subcategory
         fields = "__all__"
         widgets = {
-            "description": BBCodeEditorWidget(),
+            "description": get_editor_widget(),
         }
 
 
@@ -43,7 +44,7 @@ class ThreadAdminModelForm(forms.ModelForm):
         model = Thread
         fields = "__all__"
         widgets = {
-            "content": BBCodeEditorWidget(),
+            "content": get_editor_widget(),
         }
 
 
@@ -52,7 +53,7 @@ class PostAdminModelForm(forms.ModelForm):
         model = Post
         fields = "__all__"
         widgets = {
-            "content": BBCodeEditorWidget(),
+            "content": get_editor_widget(),
         }
 
 

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/forms.py

@@ -2,7 +2,7 @@ from django import forms
 from django.contrib.auth.forms import AuthenticationForm, UserCreationForm
 
 from punkweb_bb.models import BoardProfile, Category, Post, Shout, Subcategory, Thread
-from punkweb_bb.widgets import BBCodeEditorWidget
+from punkweb_bb.utils import get_editor_widget
 
 
 class LoginForm(AuthenticationForm):
@@ -39,7 +39,7 @@ class BoardProfileModelForm(forms.ModelForm):
             "signature",
         )
         widgets = {
-            "signature": BBCodeEditorWidget(),
+            "signature": get_editor_widget(),
         }
 
 
@@ -66,7 +66,7 @@ class PostModelForm(forms.ModelForm):
             "content": "",
         }
         widgets = {
-            "content": BBCodeEditorWidget(),
+            "content": get_editor_widget(),
         }
 
 
@@ -87,7 +87,7 @@ class SubcategoryModelForm(forms.ModelForm):
         )
         widgets = {
             "name": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
-            "description": BBCodeEditorWidget(),
+            "description": get_editor_widget(),
             "order": forms.TextInput(
                 attrs={"class": "pw-input", "min": "0", "type": "number"}
             ),
@@ -103,5 +103,13 @@ class ThreadModelForm(forms.ModelForm):
         )
         widgets = {
             "title": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
-            "content": BBCodeEditorWidget(),
+            "content": get_editor_widget(),
         }
+
+
+class ThreadMoveForm(forms.Form):
+    subcategory = forms.ModelChoiceField(
+        queryset=Subcategory.objects.all(),
+        empty_label="Select a subcategory",
+        widget=forms.Select(attrs={"class": "pw-input"}),
+    )

punkweb_bb-0.3.0/punkweb_bb/migrations/0005_alter_thread_options.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.11 on 2024-05-30 02:25
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("punkweb_bb", "0004_groupstyle"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="thread",
+            options={
+                "ordering": ("subcategory", "-is_pinned", "-last_post_created_at"),
+                "permissions": (
+                    ("move_thread", "Can move thread"),
+                    ("pin_thread", "Can pin thread"),
+                    ("close_thread", "Can close thread"),
+                ),
+            },
+        ),
+    ]

punkweb_bb-0.3.0/punkweb_bb/migrations/0006_remove_boardprofile__signature_rendered_and_more.py

@@ -0,0 +1,60 @@
+# Generated by Django 4.2.11 on 2024-05-30 21:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("punkweb_bb", "0005_alter_thread_options"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="boardprofile",
+            name="_signature_rendered",
+        ),
+        migrations.RemoveField(
+            model_name="groupstyle",
+            name="_username_style_rendered",
+        ),
+        migrations.RemoveField(
+            model_name="post",
+            name="_content_rendered",
+        ),
+        migrations.RemoveField(
+            model_name="subcategory",
+            name="_description_rendered",
+        ),
+        migrations.RemoveField(
+            model_name="thread",
+            name="_content_rendered",
+        ),
+        migrations.AlterField(
+            model_name="boardprofile",
+            name="signature",
+            field=models.TextField(blank=True, default="", max_length=1024),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="groupstyle",
+            name="username_style",
+            field=models.TextField(),
+        ),
+        migrations.AlterField(
+            model_name="post",
+            name="content",
+            field=models.TextField(),
+        ),
+        migrations.AlterField(
+            model_name="subcategory",
+            name="description",
+            field=models.TextField(blank=True, default=""),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="thread",
+            name="content",
+            field=models.TextField(),
+        ),
+    ]

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/models.py

@@ -8,7 +8,6 @@ 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
 
 from punkweb_bb.mixins import TimestampMixin, UUIDPrimaryKeyMixin
 from punkweb_bb.utils import get_highest_priority_group, get_styled_username
@@ -24,7 +23,7 @@ def profile_image_upload_to(instance, filename):
 class BoardProfile(UUIDPrimaryKeyMixin, TimestampMixin):
     user = models.OneToOneField(User, related_name="profile", on_delete=models.CASCADE)
     image = models.ImageField(upload_to=profile_image_upload_to, blank=True, null=True)
-    signature = BBCodeTextField(max_length=1024, blank=True, null=True)
+    signature = models.TextField(max_length=1024, blank=True)
 
     class Meta:
         ordering = ("user__username",)
@@ -76,7 +75,7 @@ class Subcategory(UUIDPrimaryKeyMixin, TimestampMixin):
     )
     name = models.CharField(max_length=255)
     slug = models.SlugField(max_length=1024, unique=True)
-    description = BBCodeTextField(blank=True, null=True)
+    description = models.TextField(blank=True)
     order = models.PositiveIntegerField(default=0)
     staff_post_only = models.BooleanField(default=False)
 
@@ -116,7 +115,7 @@ class Thread(UUIDPrimaryKeyMixin, TimestampMixin):
     )
     user = models.ForeignKey(User, related_name="threads", on_delete=models.CASCADE)
     title = models.CharField(max_length=255)
-    content = BBCodeTextField()
+    content = models.TextField()
     is_pinned = models.BooleanField(default=False)
     is_closed = models.BooleanField(default=False)
     last_post_created_at = models.DateTimeField(auto_now_add=True)
@@ -129,6 +128,7 @@ class Thread(UUIDPrimaryKeyMixin, TimestampMixin):
             "-last_post_created_at",
         )
         permissions = (
+            ("move_thread", "Can move thread"),
             ("pin_thread", "Can pin thread"),
             ("close_thread", "Can close thread"),
         )
@@ -160,7 +160,7 @@ class Thread(UUIDPrimaryKeyMixin, TimestampMixin):
 class Post(UUIDPrimaryKeyMixin, TimestampMixin):
     thread = models.ForeignKey(Thread, related_name="posts", on_delete=models.CASCADE)
     user = models.ForeignKey(User, related_name="posts", on_delete=models.CASCADE)
-    content = BBCodeTextField()
+    content = models.TextField()
 
     class Meta:
         ordering = ("created_at",)
@@ -222,7 +222,7 @@ class GroupStyle(UUIDPrimaryKeyMixin, TimestampMixin):
         default=0,
         help_text="Highest priority is displayed",
     )
-    username_style = BBCodeTextField()
+    username_style = models.TextField()
 
     class Meta:
         ordering = ("-priority",)

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/settings.py

@@ -4,6 +4,7 @@ PUNKWEB_BB = getattr(settings, "PUNKWEB_BB", {})
 
 SITE_NAME = PUNKWEB_BB.get("SITE_NAME", "PUNKWEB")
 SITE_TITLE = PUNKWEB_BB.get("SITE_TITLE", "PunkwebBB")
+RENDERER = PUNKWEB_BB.get("RENDERER", "bbcode")
 FAVICON = PUNKWEB_BB.get("FAVICON", "punkweb_bb/favicon.ico")
 OG_IMAGE = PUNKWEB_BB.get("OG_IMAGE", None)
 SHOUTBOX_ENABLED = PUNKWEB_BB.get("SHOUTBOX_ENABLED", True)

{punkweb_bb-0.2.3 → punkweb_bb-0.3.0}/punkweb_bb/static/punkweb_bb/css/thread.css

@@ -97,6 +97,30 @@
   gap: 1rem;
 }
 
+.threadMoveForm {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+}
+
+.threadMoveForm__field {
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+}
+
+.threadMoveForm .errorlist {
+  color: var(--oc-red-9);
+  margin: 0;
+}
+
+.threadMoveForm__actions {
+  align-items: center;
+  display: flex;
+  justify-content: flex-end;
+  gap: 1rem;
+}
+
 @media screen and (max-width: 1024px) {
   .thread {
     flex-direction: column;

punkweb_bb-0.3.0/punkweb_bb/static/punkweb_bb/editor/markdown-editor.js

@@ -0,0 +1,23 @@
+function initMarkdownEditor(element) {
+  var editor = new TinyMDE.Editor({
+    textarea: element,
+  });
+
+  var toolbarElement = document.createElement("div");
+  toolbarElement.id = "markdown-editor-toolbar";
+  element.parentNode.insertBefore(toolbarElement, element);
+
+  new TinyMDE.CommandBar({
+    element: toolbarElement,
+    editor: editor,
+  });
+}
+
+$(function () {
+  $(document).ready(function () {
+    var editorElements = document.querySelectorAll(".markdown-editor");
+    editorElements.forEach((element) => {
+      initMarkdownEditor(element);
+    });
+  });
+});