punkweb-bb 0.5.0__tar.gz → 0.5.2__tar.gz

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: punkweb_bb
-Version: 0.5.0
+Version: 0.5.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
@@ -15,38 +15,70 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: django>=4.0
+Requires-Dist: bbcode
+Requires-Dist: markdown
+Requires-Dist: pillow
+Requires-Dist: expiringdict
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # PunkwebBB
 
-PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
+## What is PunkwebBB?
+
+PunkwebBB is a Django application that provides a complete forum board solution for Django websites. What sets it apart is its focus on simplicity and independence - it doesn't rely on other Django apps, making it incredibly straightforward to install and configure. The goal? To have a fully functional forum up and running in under a minute.
 
 Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
-## Built with
+## Requirements
+
+- Python 3.9+
+- Django 3.2+
+
+It may work with older versions of Python and Django, but it has not been tested.
+
+## Key Features
+
+### 1. Modern Technology Stack
 
 - [Django](https://www.djangoproject.com/)
 - [HTMX](https://htmx.org/)
-- [jQuery](https://jquery.com/)
 - [bbcode](https://pypi.org/project/bbcode/)
 - [Markdown](https://pypi.org/project/Markdown/)
 - [SCEditor](https://www.sceditor.com/)
 - [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
 
-## Requirements
+### 2. Core Functionality
 
-- Python 3.9+
-- Django 4.0+
+- User registration and authentication
+- Thread and post management
+- Real-time shoutbox
+- Discord integration
+- BBCode and Markdown parsing
+- Responsive design
+- Admin controls and moderation tools
 
-It may work with older versions of Python and Django, but it has not been tested.
+## Getting Started
 
-## Installation
+### Installation
 
 ```bash
 pip install punkweb-bb
 ```
 
-Add `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
+### Configuration
+
+Add to your Django settings:
 
 ```python
 INSTALLED_APPS = [
@@ -64,46 +96,75 @@ MIDDLEWARE = [
 ]
 ```
 
-Add the following URL pattern to your `urls.py`:
+### URL Configuration
 
 ```python
 from django.urls import path, include
 
 urlpatterns = [
     ...
-    path("forum/", include("punkweb_bb.urls")), # or any other path you want
+    path("forum/", include("punkweb_bb.urls")),
 ]
 ```
 
-And finally, install the models:
+## Customization Options
 
-```bash
-python manage.py migrate
+PunkwebBB comes with a range of configurable settings:
+
+```python
+PUNKWEB_BB = {
+    "SITE_NAME": "Your Site Name",
+    "SITE_TITLE": "Your Forum Title",
+    "PARSER": "bbcode",  # or "markdown"
+    "FAVICON": "path/to/favicon.ico",
+    "OG_IMAGE": None,  # Full URL for Open Graph meta tags
+    "SHOUTBOX_ENABLED": True,
+    "SHOUTBOX_POLLING_ENABLED": True,
+    "SHOUTBOX_POLLING_INTERVAL": 30,  # seconds
+    "DISCORD_WIDGET_ENABLED": False,
+    "DISCORD_WIDGET_THEME": "dark",
+    "DISCORD_SERVER_ID": None,
+}
 ```
 
-## Deprecated notice (v0.5.0)
+## Why Choose PunkwebBB?
 
-If you were using the package before v0.5.0, there was a step in the README to add a context processor. This is no longer necessary, as it's been removed, so you may get an error that it doesn't exist. If you see this error, you can safely remove the context processor from your settings.
+### 1. Simplicity
 
-## Configuration
+The installation process is straightforward, and the default configuration works out of the box. You don't need to be a Django expert to get started.
 
-These are the default settings for PunkwebBB, which can be overridden in your Django settings module:
+### 2. Independence
 
-```python
-PUNKWEB_BB = {
-  "SITE_NAME": "PUNKWEB",
-  "SITE_TITLE": "PunkwebBB",
-  "PARSER": "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,
-  "SHOUTBOX_POLLING_ENABLED": True,
-  "SHOUTBOX_POLLING_INTERVAL": 30, # in seconds
-  "DISCORD_WIDGET_ENABLED": False,
-  "DISCORD_WIDGET_THEME": "dark",
-  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
-}
-```
+Unlike many forum solutions that require multiple dependencies, PunkwebBB is self-contained. This means fewer potential points of failure and easier maintenance.
+
+### 3. Modern Features
+
+From real-time shoutbox to Discord integration, PunkwebBB includes features that modern communities expect.
+
+### 4. Extensibility
+
+While it's simple to set up, PunkwebBB is also highly customizable. You can extend its functionality to match your specific needs.
+
+### 5. Performance
+
+Built with efficiency in mind, PunkwebBB handles user interactions smoothly without unnecessary overhead.
+
+## Real-World Applications
+
+PunkwebBB is ideal for:
+
+- Gaming communities
+- Business support forums
+- Educational platforms
+- Technical discussion boards
+- Fan communities
+- Knowledge-sharing platforms
+
+## Conclusion
+
+PunkwebBB represents a perfect balance between simplicity and functionality. Whether you're building a small community forum or a large-scale discussion platform, it provides all the essential features while remaining easy to implement and maintain.
+
+The project's focus on independence and straightforward installation makes it an excellent choice for developers who want to add forum functionality to their Django projects without the complexity of larger forum solutions.
 
 ## Testing
 

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/README.md

@@ -1,34 +1,51 @@
 # PunkwebBB
 
-PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
+## What is PunkwebBB?
+
+PunkwebBB is a Django application that provides a complete forum board solution for Django websites. What sets it apart is its focus on simplicity and independence - it doesn't rely on other Django apps, making it incredibly straightforward to install and configure. The goal? To have a fully functional forum up and running in under a minute.
 
 Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
-## Built with
+## Requirements
+
+- Python 3.9+
+- Django 3.2+
+
+It may work with older versions of Python and Django, but it has not been tested.
+
+## Key Features
+
+### 1. Modern Technology Stack
 
 - [Django](https://www.djangoproject.com/)
 - [HTMX](https://htmx.org/)
-- [jQuery](https://jquery.com/)
 - [bbcode](https://pypi.org/project/bbcode/)
 - [Markdown](https://pypi.org/project/Markdown/)
 - [SCEditor](https://www.sceditor.com/)
 - [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
 
-## Requirements
+### 2. Core Functionality
 
-- Python 3.9+
-- Django 4.0+
+- User registration and authentication
+- Thread and post management
+- Real-time shoutbox
+- Discord integration
+- BBCode and Markdown parsing
+- Responsive design
+- Admin controls and moderation tools
 
-It may work with older versions of Python and Django, but it has not been tested.
+## Getting Started
 
-## Installation
+### Installation
 
 ```bash
 pip install punkweb-bb
 ```
 
-Add `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
+### Configuration
+
+Add to your Django settings:
 
 ```python
 INSTALLED_APPS = [
@@ -46,46 +63,75 @@ MIDDLEWARE = [
 ]
 ```
 
-Add the following URL pattern to your `urls.py`:
+### URL Configuration
 
 ```python
 from django.urls import path, include
 
 urlpatterns = [
     ...
-    path("forum/", include("punkweb_bb.urls")), # or any other path you want
+    path("forum/", include("punkweb_bb.urls")),
 ]
 ```
 
-And finally, install the models:
+## Customization Options
 
-```bash
-python manage.py migrate
+PunkwebBB comes with a range of configurable settings:
+
+```python
+PUNKWEB_BB = {
+    "SITE_NAME": "Your Site Name",
+    "SITE_TITLE": "Your Forum Title",
+    "PARSER": "bbcode",  # or "markdown"
+    "FAVICON": "path/to/favicon.ico",
+    "OG_IMAGE": None,  # Full URL for Open Graph meta tags
+    "SHOUTBOX_ENABLED": True,
+    "SHOUTBOX_POLLING_ENABLED": True,
+    "SHOUTBOX_POLLING_INTERVAL": 30,  # seconds
+    "DISCORD_WIDGET_ENABLED": False,
+    "DISCORD_WIDGET_THEME": "dark",
+    "DISCORD_SERVER_ID": None,
+}
 ```
 
-## Deprecated notice (v0.5.0)
+## Why Choose PunkwebBB?
 
-If you were using the package before v0.5.0, there was a step in the README to add a context processor. This is no longer necessary, as it's been removed, so you may get an error that it doesn't exist. If you see this error, you can safely remove the context processor from your settings.
+### 1. Simplicity
 
-## Configuration
+The installation process is straightforward, and the default configuration works out of the box. You don't need to be a Django expert to get started.
 
-These are the default settings for PunkwebBB, which can be overridden in your Django settings module:
+### 2. Independence
 
-```python
-PUNKWEB_BB = {
-  "SITE_NAME": "PUNKWEB",
-  "SITE_TITLE": "PunkwebBB",
-  "PARSER": "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,
-  "SHOUTBOX_POLLING_ENABLED": True,
-  "SHOUTBOX_POLLING_INTERVAL": 30, # in seconds
-  "DISCORD_WIDGET_ENABLED": False,
-  "DISCORD_WIDGET_THEME": "dark",
-  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
-}
-```
+Unlike many forum solutions that require multiple dependencies, PunkwebBB is self-contained. This means fewer potential points of failure and easier maintenance.
+
+### 3. Modern Features
+
+From real-time shoutbox to Discord integration, PunkwebBB includes features that modern communities expect.
+
+### 4. Extensibility
+
+While it's simple to set up, PunkwebBB is also highly customizable. You can extend its functionality to match your specific needs.
+
+### 5. Performance
+
+Built with efficiency in mind, PunkwebBB handles user interactions smoothly without unnecessary overhead.
+
+## Real-World Applications
+
+PunkwebBB is ideal for:
+
+- Gaming communities
+- Business support forums
+- Educational platforms
+- Technical discussion boards
+- Fan communities
+- Knowledge-sharing platforms
+
+## Conclusion
+
+PunkwebBB represents a perfect balance between simplicity and functionality. Whether you're building a small community forum or a large-scale discussion platform, it provides all the essential features while remaining easy to implement and maintain.
+
+The project's focus on independence and straightforward installation makes it an excellent choice for developers who want to add forum functionality to their Django projects without the complexity of larger forum solutions.
 
 ## Testing
 

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/bbcode.py

@@ -1,5 +1,13 @@
 import bbcode
 
+from punkweb_bb.settings import ALLOWED_URL_SCHEMES
+
+def safe_url(href):
+    href = (href or "").strip()
+    if not href:
+        return None
+    lower = href.lower()
+    return href if any(lower.startswith(s + ":") for s in ALLOWED_URL_SCHEMES) else None
 
 def add_font_tag(parser):
     def _render_font(name, value, options, parent, context):
@@ -40,19 +48,23 @@ def add_shadow_tag(parser):
 
     parser.add_formatter("shadow", _render_shadow)
 
-
 def add_url_tag(parser):
     def _render_url(name, value, options, parent, context):
         if "url" in options:
-            url = options["url"]
+            url = safe_url(options["url"])
+            if url is None:
+                return value
             return f'<a href="{url}">{value}</a>'
-        return f'<a href="{value}">{value}</a>'
+
+        url = safe_url(value)
+        if url is None:
+            return value
+        return f'<a href="{url}">{value}</a>'
 
     parser.add_formatter(
         "url", _render_url, replace_links=False, replace_cosmetic=False
     )
 
-
 def add_quote_tag(parser):
     def _render_quote(name, value, options, parent, context):
         if "quote" in options:

punkweb_bb-0.5.2/punkweb_bb/migrations/0008_alter_groupstyle_username_style.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.11 on 2024-10-08 21:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('punkweb_bb', '0007_boardprofile_bio'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='groupstyle',
+            name='username_style',
+            field=models.TextField(help_text='BBCode style for the username.  Use {USER} as a placeholder for the username.  Example: [b]{USER}[/b]'),
+        ),
+    ]

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/models.py

@@ -195,9 +195,10 @@ 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:
+            if self.thread.is_closed:
+                raise ValidationError("Cannot add posts to a closed thread.")
+
             self.thread.last_post_created_at = timezone.now()
             self.thread.save()
         super().save(*args, **kwargs)
@@ -223,7 +224,9 @@ class GroupStyle(UUIDPrimaryKeyMixin, TimestampMixin):
         default=0,
         help_text="Highest priority is displayed",
     )
-    username_style = models.TextField()
+    username_style = models.TextField(
+        help_text="BBCode style for the username.  Use {USER} as a placeholder for the username.  Example: [b]{USER}[/b]"
+    )
 
     class Meta:
         ordering = ("-priority",)

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/settings.py

@@ -13,3 +13,5 @@ SHOUTBOX_POLLING_INTERVAL = PUNKWEB_BB.get("SHOUTBOX_POLLING_INTERVAL", 30)
 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)
+# allow listing `javascript` will enable the weaponization of shoutbox bbcode.
+ALLOWED_URL_SCHEMES = PUNKWEB_BB.get("ALLOWED_URL_SCHEMES", ["http", "https"])

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/static/punkweb_bb/css/bbcode-editor-content.css

@@ -72,6 +72,10 @@ code {
   direction: ltr;
 }
 
+pre code {
+  font-size: 0.75rem;
+}
+
 blockquote {
   background: #f1f3f5;
   margin: 0.25rem 0;

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/static/punkweb_bb/css/members.css

@@ -42,3 +42,9 @@
 .members__user__stat__value {
   color: var(--oc-gray-9);
 }
+
+@media screen and (max-width: 768px) {
+  .members__header {
+    flex-direction: column;
+  }
+}

{punkweb_bb-0.5.0 → punkweb_bb-0.5.2}/punkweb_bb/static/punkweb_bb/css/punkweb.css

@@ -154,3 +154,7 @@ hr {
   margin: 0;
   padding: 0;
 }
+
+pre[class*="language-"] {
+  font-size: 0.75rem;
+}