Rename module to wagtail-polymath

.github/workflows/ruff.yml

@@ -34,4 +34,4 @@ jobs:
 
       - name: Run ruff
         working-directory: ./src
-        run: ruff check --output-format=github wagtailmath
+        run: ruff check --output-format=github wagtail_polymath

README.md

@@ -2,7 +2,7 @@
 
 [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![PyPI version](https://img.shields.io/pypi/v/wagtailmath.svg?style=flat)](https://pypi.org/project/wagtailmath)
+[![PyPI version](https://img.shields.io/pypi/v/wagtailmath.svg?style=flat)](https://pypi.org/project/wagtail-polymath)
 [![Build status](https://img.shields.io/github/actions/workflow/status/wagtail-nest/wagtail-polymath/test.yml?branch=main)](https://github.com/wagtail-nest/wagtail-polymath/actions)
 
 ## Links
@@ -41,9 +41,9 @@ the markup language-specific documentation (e.g. https://en.wikibooks.org/wiki/L
 
 ## Quickstart
 
-Install wagtailmath:
+Install wagtail_polymath:
 
-    pip install wagtailmath
+    pip install wagtail_polymath
 
 Add it to your `INSTALLED_APPS`:
 
@@ -52,15 +52,16 @@ Add it to your `INSTALLED_APPS`:
 
 INSTALLED_APPS = (
     # ...
-    "wagtailmath",
+    "wagtail_polymath",
     # ...
 )
 ```
 
 Use `MathBlock` in your `StreamField` content:
 
 ```python
-from wagtailmath.blocks import MathBlock
+from wagtail_polymath.blocks import MathBlock
+
 
 class MyPage(Page):
     body = StreamField([
@@ -74,7 +75,7 @@ Use the `mathjax` template tag in your front end template to load the
 MathJax library:
 
 ```django+html
-{% load wagtailmath %}
+{% load wagtail_polymath %}
 ...
 
 <script src="{% mathjax %}"></script>

pyproject.toml

@@ -3,14 +3,14 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "wagtailmath"
+name = "wagtail-polymath"
 authors = [{name = "James Ramm", email = "jamessramm@gmail.com"}]
 maintainers = [{name = "Wagtail Nest team", email = "hello@wagtail.org"}]
 description = "Wagtail StreamField block for rendering mathematical equations"
 readme = "README.md"
 license = {file = "LICENSE"}
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
@@ -53,7 +53,7 @@ Changelog = "https://github.com/wagtail-nest/wagtail-polymath/blob/main/CHANGELO
 Documentation = "https://github.com/wagtail-nest/wagtail-polymath/blob/main/docs/"
 
 [tool.flit.module]
-name = "wagtailmath"
+name = "wagtail_polymath"
 
 [tool.flit.sdist]
 exclude = [

src/wagtail_polymath/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.0.0.dev1"

src/wagtail_polymath/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class WagtailPolymathConfig(AppConfig):
+    name = "wagtail_polymath"

src/wagtailmath/templatetags/wagtailmath.py → src/wagtail_polymath/templatetags/wagtail_polymath.py

@@ -1,6 +1,6 @@
 from django import template
 
-from wagtailmath.widgets import MATHJAX_VERSION
+from wagtail_polymath.widgets import MATHJAX_VERSION
 
 
 register = template.Library()

src/wagtailmath/widgets.py → src/wagtail_polymath/widgets.py

@@ -6,7 +6,7 @@
 
 
 class MathJaxWidget(forms.Textarea):
-    template_name = "wagtailmath/mathjaxwidget.html"
+    template_name = "wagtail_polymath/mathjaxwidget.html"
 
     def build_attrs(self, *args, **kwargs):
         attrs = super().build_attrs(*args, **kwargs)
@@ -19,7 +19,9 @@ def media(self):
         return forms.Media(
             js=(
                 f"https://cdnjs.cloudflare.com/ajax/libs/mathjax/{MATHJAX_VERSION}/MathJax.js?config=TeX-MML-AM_HTMLorMML",
-                versioned_static("wagtailmath/js/wagtailmath.js"),
-                versioned_static("wagtailmath/js/wagtailmath-mathjax-controller.js"),
+                versioned_static("wagtail_polymath/js/wagtail_polymath.js"),
+                versioned_static(
+                    "wagtail_polymath/js/wagtail_polymath-mathjax-controller.js"
+                ),
             )
         )

tests/testapp/migrations/0001_initial.py

@@ -3,10 +3,11 @@
 import django.db.models.deletion
 import wagtail.blocks
 import wagtail.fields
-import wagtailmath.blocks
 
 from django.db import migrations, models
 
+import wagtail_polymath.blocks
+
 
 class Migration(migrations.Migration):
     initial = True
@@ -39,7 +40,7 @@ class Migration(migrations.Migration):
                                 wagtail.blocks.CharBlock(form_classname="full title"),
                             ),
                             ("paragraph", wagtail.blocks.RichTextBlock()),
-                            ("equation", wagtailmath.blocks.MathBlock()),
+                            ("equation", wagtail_polymath.blocks.MathBlock()),
                         ],
                         use_json_field=True,
                     ),

tests/testapp/models.py

@@ -2,7 +2,8 @@
 from wagtail.admin.panels import FieldPanel
 from wagtail.fields import StreamField
 from wagtail.models import Page
-from wagtailmath.blocks import MathBlock
+
+from wagtail_polymath.blocks import MathBlock
 
 
 class MathPage(Page):

tests/testproject/settings.py

@@ -33,7 +33,7 @@
 # Application definition
 
 INSTALLED_APPS = [
-    "wagtailmath",
+    "wagtail_polymath",
     "testapp",
     "wagtail.users",
     "wagtail.snippets",