rename URL resolver functions

Author: rmorshea

README.md

@@ -53,7 +53,7 @@ your_app/
 To start, we'll need to use [`channels`](https://channels.readthedocs.io/en/stable/) to
 create a `ProtocolTypeRouter` that will become the top of our ASGI application stack.
 Under the `"websocket"` protocol, we'll then add a path for IDOM's websocket consumer
-using `django_idom_websocket_consumer_path`. If you wish to change the route where this
+using `idom_websocket_path`. If you wish to change the route where this
 websocket is served from see the [settings](#configuration-options).
 
 ```python
@@ -62,7 +62,7 @@ import os
 
 from django.core.asgi import get_asgi_application
 
-from django_idom import django_idom_websocket_consumer_path
+from django_idom import idom_websocket_path
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_app.settings")
 
@@ -76,7 +76,7 @@ application = ProtocolTypeRouter(
         "http": http_asgi_app,
         "websocket": URLRouter(
           # add a path for IDOM's websocket
-          [django_idom_websocket_consumer_path()]
+          [idom_websocket_path()]
         ),
     }
 )
@@ -158,17 +158,17 @@ Your view for this template can be defined just
 ## `urls.py`
 
 To your list of URLs you'll need to include IDOM's static web modules path using
-`django_idom_web_modules_path`:
+`idom_web_modules_path`:
 
 ```python
 from django.urls import path
-from django_idom import django_idom_web_modules_path
+from django_idom import idom_web_modules_path
 from .views import your_template  # define this view like any other HTML template
 
 
 urlpatterns = [
     path("", your_template),
-    django_idom_web_modules_path(),
+    idom_web_modules_path(),
 ]
 ```
 

src/django_idom/__init__.py

@@ -1,5 +1,5 @@
-from .app_paths import django_idom_web_modules_path, django_idom_websocket_consumer_path
+from .app_paths import idom_web_modules_path, idom_websocket_path
 
 
 __version__ = "0.0.1"
-__all__ = ["django_idom_websocket_consumer_path", "django_idom_web_modules_path"]
+__all__ = ["idom_websocket_path", "idom_web_modules_path"]

src/django_idom/app_paths.py

@@ -5,12 +5,12 @@
 from .websocket_consumer import IdomAsyncWebSocketConsumer
 
 
-def django_idom_websocket_consumer_path(*args, **kwargs):
+def idom_websocket_path(*args, **kwargs):
     """Return a URL resolver for :class:`IdomAsyncWebSocketConsumer`
 
     While this is relatively uncommon in most Django apps, because the URL of the
     websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
-    to allow users to configure the URL themselves
+    to allow users to configure the URL themselves.
     """
     return path(
         IDOM_WEBSOCKET_URL + "<view_id>/",
@@ -20,7 +20,13 @@ def django_idom_websocket_consumer_path(*args, **kwargs):
     )
 
 
-def django_idom_web_modules_path(*args, **kwargs):
+def idom_web_modules_path(*args, **kwargs):
+    """Return a URL resolver for static web modules required by IDOM
+
+    While this is relatively uncommon in most Django apps, because the URL of the
+    websocket must be defined by the setting ``IDOM_WEBSOCKET_URL``. There's no need
+    to allow users to configure the URL themselves.
+    """
     return path(
         IDOM_WEB_MODULES_URL + "<path:file>",
         views.web_modules_file,

tests/test_app/asgi.py

@@ -11,7 +11,7 @@
 
 from django.core.asgi import get_asgi_application
 
-from django_idom import django_idom_websocket_consumer_path
+from django_idom import idom_websocket_path
 
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_app.settings")
@@ -25,6 +25,6 @@
 application = ProtocolTypeRouter(
     {
         "http": http_asgi_app,
-        "websocket": URLRouter([django_idom_websocket_consumer_path()]),
+        "websocket": URLRouter([idom_websocket_path()]),
     }
 )

tests/test_app/urls.py

@@ -19,12 +19,12 @@
 """
 from django.urls import path
 
-from django_idom import django_idom_web_modules_path
+from django_idom import idom_web_modules_path
 
 from .views import base_template
 
 
 urlpatterns = [
     path("", base_template),
-    django_idom_web_modules_path(),
+    idom_web_modules_path(),
 ]