django-router 1.0

Use simple decorators on views instead of maintaining lengthy urls.py

Django Router

Maintaining Django's urls.py can become really annoying when you have a lot of 'em(dozens in single file). Other frameworks deal with the problem in more elegant ways, like Flask's @app.route decorator. This project brings same concept to Django by adding @router decorator functions. No more need to deal with lengthy urls.py.

What you get

Just use decorator in your app's views.py. Django Router uses autodiscovery feature, so make sure views you're interested in are either inside views.py or get imported into it.

# employees/views.py
from django_router import router
from employees.models import Employee
from django.shortcuts import render
from django.views.generic.edit import CreateView

# Works with function based views
# Resulting url will be `/employees/employee_list/`
@router.path()
def employee_list(request):
    employees = Employee.objects.all()
    return render(request, 'employee_list.html', {'employees':employees})

# As well as with class based views
# Resulting url will be `/employees/employee_create/`
@router.path()
def EmployeeCreate(CreateView):
    model = Employee

And that's it!

How it works

Router has two functions path and re_path which work exactly the same as django.urls functions you already know. Except that you don't even need to specify url or name.

If no name is provided function name will be used, camel case will be turned into snake case:

# same as path('import_employees/', import_employees, name='import_employees')
@router.path()
def import_employees(request):
    ...

# same as path('import_employees/', ImportEmployees.as_view(), name='import_employees')
@router.path()
class ImportEmployees(View):
    ...

Of course you can specify path and name as usual:

@router.path('im_emp/', name='employees_import')
def import_employees(request):
    ...

Settings

Settings for the project are mostly to control autonaming behavior. These are default settings for the project

ROUTER_SETTINGS={
    "NAME_WORDS_SEPARATOR": "_"
    "TRY_USE_MODEL_NAMES": True
    "MODEL_NAMES_MONOLITHIC": True
}

---

NAME_WORDS_SEPARATOR: a separator char that'll be used during camel to snake case conversion in view names:

@router.path()
class EmployeeList(ListView):
    model = Employee

NAME_WORDS_SEPARATOR = "_"

path('employee_list/', EmployeeList.as_view(), name='employee_list')

NAME_WORDS_SEPARATOR = "-"

path('employee_list/', EmployeeList.as_view(), name='employee-list')

---

TRY_USE_MODEL_NAMES: try to use model name for view naming within CBV while forming URLs

@router.path()
class Employees(ListView):
    model = Employee

TRY_USE_MODEL_NAMES = True

path('employee_list/', Employees.as_view(), name='employee_list')

TRY_USE_MODEL_NAMES = False

path('employees/', Employees.as_view(), name='employees')

---

MODEL_NAMES_MONOLITHIC: only works when TRY_USE_MODEL_NAMES = True, control whether separator is used for model names consisting of multiple words

@router.path()
class EmployeeAddressList(ListView):
    model = EmployeeAddress

MODEL_NAMES_MONOLITHIC = True

path('employeeaddress/', EmployeesAddressList.as_view(), name='employeeaddress_list')

MODEL_NAMES_MONOLITHIC = False

path('employee_address/', EmployeesAddressList.as_view(), name='employee_address_list')

Management command

You can run python manage.py routerlist to see list of all available routes created by the router.