Django-Routify is a package for simple routing Views in the classic Django framework.
Project description
Django-Routify
Django-Routify is a lightweight package designed to simplify routing views in the classic Django framework.
With Django-Routify, you no longer need to manually register your views in urlpatterns
using Django's path()
function. Instead, the package introduces the Router
class, allowing you to easily register views using the @Router.route(url_path=...)
decorator. This approach is similar to what you might already be familiar with from frameworks like Flask, FastAPI, or Django REST Framework (DRF), where views are registered with decorators. This not only makes your code easier to read but also streamlines the process of routing.
Additionally, Django-Routify provides the option to set auto_trailing_slash=True
when initializing the Router
. This allows you to write URL paths similar to those in Flask or FastAPI, such as /hello-world
, which will be automatically translated into the classic Django URL format: hello-world/
.
Django-Routify supports both function-based
and class-based
views, as well as asynchronous
views, providing flexibility for different project needs.
Documentation
Documentation are already available here!
Example
For extended example with tests visit examples/example.
Using Django-Routify with Django
~/project/app/views.py:
from django.http import HttpRequest, HttpResponse
from django_routify import Router
router = Router('/app', 'app', auto_trailing_slash=True)
@router.route('/hello-world', methods=['GET']) # or @router.get('/hello-world')
def hello_world(request: HttpRequest) -> HttpResponse:
return HttpResponse('Hello World!')
~/project/app/urls.py:
from django_routify import include_router
from .views import router
urlpatterns = [
include_router(router),
]
Using classic Django
~/project/app/views.py:
from django.http import HttpRequest, HttpResponse
from django.views.decorators.http import require_http_methods
@require_http_methods(['GET'])
def hello_world(request: HttpRequest) -> HttpResponse:
return HttpResponse('Hello World!')
~/project/app/urls.py:
from django.urls import path, include
from .views import hello_world
app_name = 'app'
urlpatterns = [
path(
'app/',
include(
[
path('hello-world/', hello_world, name='hello_world'),
]
),
),
]
Note:
The result of these two examples will do the same thing
Requirements
- Python 3.8+
- Django 4.0+
Installation
To install Django-Routify package use the command below in your environment:
- Using
pip
pip install django-routify
- Using
Poetry
poetry add django-routify
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_routify-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 823cb7e1fb93e972fd56cf6d628ec404ff5a49060f232f2d55c9bdab4a35ffc4 |
|
MD5 | 146f4dc6e720553565101822d50081fa |
|
BLAKE2b-256 | 6229e50a79fc643897e7ce5e54857e5c07a0b70b20c42c790fd94646f8b6ac99 |