URL Routing System

from django.views.generic import TemplateView
from django.urls import path
from material.urls import Viewset, route

class MyViewset(Viewset):
    app_name = "myapp"
    
    # Define URL patterns as class attributes
    home_path = path("", TemplateView.as_view(template_name="myapp/home.html"), name="home")
    about_path = path("about/", TemplateView.as_view(template_name="myapp/about.html"), name="about")
    
    # Nest another viewset
    admin_path = route("admin/", AdminViewset())

# Use in your urls.py
urlpatterns = [
    path("", MyViewset().urls)
]

route(prefix: str, viewset: BaseViewset) -> Route

# Example
admin_path = route("admin/", AdminViewset())

class MyViewset(IndexViewMixin, Viewset):
    app_name = "myapp"
    
    # The index path will be auto-created to redirect to the first suitable URL
    home_path = path("home/", HomeView.as_view(), name="home")
    about_path = path("about/", AboutView.as_view(), name="about")

from django.views.generic import TemplateView
from django.urls import path
from material.urls import Viewset

class UserViewset(Viewset):
    app_name = "users"
    
    list_path = path("", UserListView.as_view(), name="list")
    detail_path = path("/", UserDetailView.as_view(), name="detail")
    create_path = path("new/", UserCreateView.as_view(), name="create")
    update_path = path("/edit/", UserUpdateView.as_view(), name="update")
    delete_path = path("/delete/", UserDeleteView.as_view(), name="delete")

from material.urls import Viewset, route

class PostViewset(Viewset):
    app_name = "posts"
    # Post URL patterns...

class CommentViewset(Viewset):
    app_name = "comments"
    # Comment URL patterns...

class BlogViewset(Viewset):
    app_name = "blog"
    
    # Main blog URLs
    home_path = path("", BlogHomeView.as_view(), name="home")
    
    # Nested viewsets
    posts_path = route("posts/", PostViewset())
    comments_path = route("comments/", CommentViewset())

from django.views.generic import TemplateView
from django.urls import path
from material.urls import route
from material.urls.sites import Site, Application, AppMenuMixin

# Define a model viewset that will be part of an application
class ProductViewset(AppMenuMixin, Viewset):
    title = "Products"
    icon = "inventory_2"
    
    list_path = path("", ProductListView.as_view(), name="list")
    detail_path = path("/", ProductDetailView.as_view(), name="detail")
    
    # Get URL for a product object
    def get_object_url(self, request, obj):
        return self.reverse("detail", args=[obj.pk])

# Define an application
class ShopApplication(Application):
    title = "Online Shop"
    icon = "shopping_cart" 
    permission = "shop.view_shop"  # Permission required to access this app
    
    # Direct URL patterns
    dashboard_path = path("", DashboardView.as_view(), name="dashboard")
    settings_path = path("settings/", SettingsView.as_view(), name="settings")
    
    # Add the product viewset
    products_path = route("products/", ProductViewset())

# Define another application
class BlogApplication(Application):
    title = "Blog"
    icon = "article"
    
    post_list_path = path("", PostListView.as_view(), name="post_list")
    post_detail_path = path("/", PostDetailView.as_view(), name="post_detail")

# Create the main site
class ProjectSite(Site):
    title = "My Project"
    primary_color = "indigo"
    secondary_color = "teal"
    
    # Direct URL patterns 
    home_path = path("", HomeView.as_view(), name="home")
    about_path = path("about/", AboutView.as_view(), name="about")
    
    # Add applications
    shop_path = route("shop/", ShopApplication())
    blog_path = route("blog/", BlogApplication())

# Use in your main urls.py
site = ProjectSite()
urlpatterns = [
    path("", site.urls)
]

# Using the site structure from the previous example

# In a view or template context processor
def get_model_urls(request):
    # Get a product instance
    product = Product.objects.get(pk=1)
    
    # Get the URL for this product using the site's get_absolute_url method
    product_url = site.get_absolute_url(request, product)
    # Result: /shop/products/1/
    
    # This works for any model that has a viewset with get_object_url method
    # registered in any application in the site
    
    return {
        'product_url': product_url
    }

# URL structure from previous example
site = ProjectSite()
urlpatterns = [
    path("", site.urls)
]

# In a view
def some_view(request):
    # Get URL to site home
    home_url = site.reverse("home")  # /
    
    # Get URL to shop dashboard
    shop_url = site.shop_path.viewset.reverse("dashboard")  # /shop/
    
    # Get URL to products list
    products_url = site.shop_path.viewset.products_path.viewset.reverse("list")  # /shop/products/
    
    # Get URL to a specific product
    product_url = site.shop_path.viewset.products_path.viewset.reverse("detail", args=[1])  # /shop/products/1/

class BaseAPIViewset(Viewset):
    list_path = path("", ListView.as_view(), name="list")
    detail_path = path("/", DetailView.as_view(), name="detail")
    create_path = path("create/", CreateView.as_view(), name="create")

class UserAPIViewset(BaseAPIViewset):
    app_name = "users"
    # Override specific paths or add new ones
    detail_path = path("/", UserDetailView.as_view(), name="detail")
    profile_path = path("/profile/", ProfileView.as_view(), name="profile")

# Create a main site
site = Site(title="My Dynamic Site")

# Define an application class
class AnalyticsApplication(Application):
    title = "Analytics"
    icon = "analytics"
    
    dashboard_path = path("", AnalyticsDashboardView.as_view(), name="dashboard")
    reports_path = path("reports/", ReportsView.as_view(), name="reports")

# Register the application with the site
site.register(AnalyticsApplication)

# The app is now accessible at /analytics/
# with automatic namespace 'analytics'