django-app-router 0.0.3

A simple Django app to route requests, Inspired by Next.js App Router.

django app router

A modern, easy to use, and powerful router for Django apps. Inspired by the Next.js app router.

Features

• Dynamic routing
• Nested routing
• Route parameters
• Route groups

Requirements

• Python 3.8+
• Django 4.2+

Note Not tested with other versions.

Installing

Windows:

$ pip install -U django-app-router

Linux/MacOS:

$ python3 -m pip install -U django-app-router

Setup and Usage

<app_name>/urls.py:

from pathlib import Path

import django_app_router

urlpatterns = [
    # Your other urlpatterns
]

urlpatterns += django_app_router.init(
    # The path to the templates folder
    Path(__file__).resolve().parent / 'templates',
)

Example

for example, define a route with the file page.py in the templates folder:

from django.shortcuts import render

def page(request):
    """home"""
    # You can also name the page
    # path(..., ..., name='home')

    return render(request, 'page.html')

Route	Example URL	params
templates/page.py	/	{}
templates/info/page.py	/info/	{}
templates/(group)/about/page.py	/about/	{}
templates/user/[slug]/page.py	/user/1/	{'slug': 1}

Example folder structure

app
├── migrations
│   └── __init__.py
├── templates
│   ├── (auth)
│   │   ├── login
│   │   │   ├── page.html
│   │   │   └── page.py
│   │   └── register
│   │       ├── page.html
│   │       └── page.py
│   ├── info
│   │   └── page.py
│   ├── user
│   │   └── [user_id]
│   │       ├── page.html
│   │       └── page.py
│   ├── layout.html
│   ├── page.html
│   └── page.py
├── __init__.py
├── admin.py
├── apps.py
├── models.py
├── tests.py
├── urls.py
└── views.py

You can see the full example in the example folder.

License

This project is licensed under the MIT License - see the LICENSE file for details.