Django server-side adapter for Inertia.js

Last update: Sep 16, 2022

Related tags

Django django-inertia

Overview

django-inertia

Django server-side new adapter for Inertia.js.

Getting Started

Install the package

pip install django-inertia

Configure your project

Add the package django_inertia to your project (if you want to use the template tag else it's not necessary).
Add InertiaMiddleware to your project middlewares:

MIDDLEWARES = [
  #...,
  "django_inertia.middleware.InertiaMiddleware",
]

Creating responses

To create and inertia response you need to use Inertia.render() method:

from django_inertia import Inertia

def event_detail(request, id):
    event = Event.objects.get(pk=id)
    props = {
        'event': {
            'id':event.id,
            'title': event.title,
            'start_date': event.start_date,
            'description': event.description
        }
    }
    return Inertia.render(request, "Event/Show", props)

Loading data into your template

{% inertia %} ">

{% load inertia_tags %}

<html  class="h-full bg-gray-200">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
    <script src="{{ STATIC_URL}}dist/app.js" defer>script>
    <link href="{{ STATIC_URL}}dist/app.css" rel="stylesheet" />
  head>
  <body>
    {% inertia %}
  body>
html>

Full documentation

TODO

Inertia.share()
Inertia.render()
Inertia.version()
Inertia.get_version()
Inertia.flush_shared()

Inertia.lazy()
Inertia.static()

Credits

Thanks to Andres Vargas for the inspiration on this package. Here is the link to its legacy package which seems not be actively maintained anymore: inertia-django

Contributing

TODO

Maintainers

Samuel Girardin

License

django-inertia is open-sourced software licensed under the MIT license.

You might also like...

django-quill-editor makes Quill.js easy to use on Django Forms and admin sites

django-quill-editor django-quill-editor makes Quill.js easy to use on Django Forms and admin sites No configuration required for static files! The ent

139 Dec 5, 2022

A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, celery and redis.

Django Channels Websocket Chatbot A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, c

8 Oct 28, 2022

A handy tool for generating Django-based backend projects without coding. On the other hand, it is a code generator of the Django framework.

Django Sage Painless The django-sage-painless is a valuable package based on Django Web Framework & Django Rest Framework for high-level and rapid web

51 Sep 15, 2022

A beginner django project and also my first Django project which involves shortening of a longer URL into a short one using a unique id.

Django-URL-Shortener A beginner django project and also my first Django project which involves shortening of a longer URL into a short one using a uni

3 Aug 8, 2021

Dockerizing Django with Postgres, Gunicorn, Nginx and Certbot. A fully Django starter project.

Dockerizing Django with Postgres, Gunicorn, Nginx and Certbot 🚀 Features A Django stater project with fully basic requirements for a production-ready

8 Jun 27, 2022

pytest-django allows you to test your Django project/applications with the pytest testing tool.

1.1k Dec 14, 2022

APIs for a Chat app. Written with Django Rest framework and Django channels.

ChatAPI APIs for a Chat app. Written with Django Rest framework and Django channels. The documentation for the http end points can be found here This

18 Sep 9, 2022

django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project. Inspired in the dashboard framework Dashing

django-dashing django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project.

703 Dec 22, 2022

Django-MySQL extends Django's built-in MySQL and MariaDB support their specific features not available on other databases.

Django-MySQL The dolphin-pony - proof that cute + cute = double cute. Django-MySQL extends Django's built-in MySQL and MariaDB support their specific

504 Jan 4, 2023

Comments

Add type annotations

This should be mostly correct, I'm a little unsure whether the request parameter in assertations.py is HttpRequest or something else though. I also fixed a potential issue for users that define their own setting for INERTIA_PAGE_CONTEXT. Closes #2

Also just realized that my code should be formatted with black, I'll do that later. Let me know if you have any other style preferences too.

opened by pmdevita 2

Generated value for data-page not JSON-parsable

Got this error:

Uncaught (in promise) SyntaxError: Unexpected token ' in JSON at position 1
    at JSON.parse (<anonymous>)
    at exports.createInertiaApp (index.js?4bf4:1:9213)
    at eval (app.js?5e94:7:17)
    at Module../demo/static/src/app.js (app.js:455:1)
    at __webpack_require__ (app.js:797:42)
    at app.js:861:37
    at app.js:863:12

I believe this is because the generated data-page attribute string:

<div id="app" data-page="{'component': 'Dashboard/Index', 'props': {'errors': False, 'success': False}, 'url': '/', 'version': '1'}"></div>

is not valid JSON, hence the error.

Valid JSON should be:

double quotes, not single quotes
False is not a valid keyword in JSON, but false is (with a lower cap "f")

Below is a screenshot of the error:

No errors after manually editing the generated data-page attribute string to a valid JSON string:

bug

opened by mujahidfa 2

Use idiomatic Django to reference static files

Hi @girardinsamuel!

Just thought to improve the docs a bit by using Django's static template tag to reference the generated JS and CSS files in the template. I believe this is more idiomatic Django over using using {{ STATIC_URL }} directly in the template (unless there's another reason that I'm not aware of for it).

Reference: https://docs.djangoproject.com/en/4.0/howto/static-files/#configuring-static-files

Great work with this library btw 👍👍

Thanks!

opened by mujahidfa 1

Releases(v1.3.0)

v1.3.0(May 12, 2022)
Changed

Used idiomatic Django to reference static files by @mujahidfa in https://github.com/girardinsamuel/django-inertia/pull/6

Fixed

Ensured valid JSON string is generated in the data-page attr by @mujahidfa in https://github.com/girardinsamuel/django-inertia/pull/8

New Contributors

@mujahidfa made their first contribution in https://github.com/girardinsamuel/django-inertia/pull/6

Full Changelog: https://github.com/girardinsamuel/django-inertia/compare/v1.2.0...v1.3.0
Source code(tar.gz)
Source code(zip)
v1.2.0(Apr 26, 2022)
Changed

Add view_data keyword argument to Inertia.render() method allowing to pass context to django template and not to Inertia view by @muarachmann in https://github.com/girardinsamuel/django-inertia/pull/5

A new parameter INERTIA_PAGE_CONTEXT has been added which default to __page to define the context template variable used to pass data from backend to frontend.

New Contributors

@muarachmann made their first contribution in https://github.com/girardinsamuel/django-inertia/pull/5

Full Changelog: https://github.com/girardinsamuel/django-inertia/compare/v1.1.0...v1.2.0
Source code(tar.gz)
Source code(zip)
v1.1.0(Feb 17, 2022)
Changed

Marked package compatible with Django 4

Full Changelog: https://github.com/girardinsamuel/django-inertia/compare/v1.0.1...v1.1.0
Source code(tar.gz)
Source code(zip)
v1.0.1(Feb 11, 2022)
Fixed

Fix default sharing of errors and success messages. They are now removed after being added to the response, so that they are really non persistent flash messages.

Full Changelog: https://github.com/girardinsamuel/django-inertia/commits/v1.0.1
Source code(tar.gz)
Source code(zip)

Owner

Samuel Girardin

Full-Stack Engineer (Python, Vue.js)

GitHub Repository

demo project for django channels tutorial

django_channels_chat_official_tutorial demo project for django channels tutorial code from tutorial page: https://channels.readthedocs.io/en/stable/tu

1 Oct 22, 2021

The Django Leaflet Admin List package provides an admin list view featured by the map and bounding box filter for the geo-based data of the GeoDjango.

The Django Leaflet Admin List package provides an admin list view featured by the map and bounding box filter for the geo-based data of the GeoDjango. It requires a django-leaflet package.

33 Nov 11, 2022

Django Query Capture can check the query situation at a glance, notice slow queries, and notice where N+1 occurs.

django-query-capture Overview Django Query Capture can check the query situation at a glance, notice slow queries, and notice where N+1 occurs. Some r

80 Nov 22, 2022

Django-Audiofield is a simple app that allows Audio files upload, management and conversion to different audio format (mp3, wav & ogg), which also makes it easy to play audio files into your Django application.

Django-Audiofield Description: Django Audio Management Tools Maintainer: Areski Contributors: list of contributors Django-Audiofield is a simple app t

167 Nov 10, 2022

Django server-side adapter for Inertia.js

Related tags

Overview

django-inertia

Getting Started

Install the package

Configure your project

Creating responses

Loading data into your template

Full documentation

Credits

Contributing

Maintainers

License

You might also like...

django-quill-editor makes Quill.js easy to use on Django Forms and admin sites

A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, celery and redis.

A handy tool for generating Django-based backend projects without coding. On the other hand, it is a code generator of the Django framework.

A beginner django project and also my first Django project which involves shortening of a longer URL into a short one using a unique id.

Dockerizing Django with Postgres, Gunicorn, Nginx and Certbot. A fully Django starter project.

pytest-django allows you to test your Django project/applications with the pytest testing tool.

APIs for a Chat app. Written with Django Rest framework and Django channels.

django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project. Inspired in the dashboard framework Dashing

Django-MySQL extends Django's built-in MySQL and MariaDB support their specific features not available on other databases.

Comments

Add type annotations

Generated value for data-page not JSON-parsable

Use idiomatic Django to reference static files

Releases(v1.3.0)

v1.3.0(May 12, 2022)

Changed

Fixed

New Contributors

v1.2.0(Apr 26, 2022)

Changed

New Contributors

v1.1.0(Feb 17, 2022)

Changed

v1.0.1(Feb 11, 2022)

Fixed

Owner

Samuel Girardin

demo project for django channels tutorial

The Django Leaflet Admin List package provides an admin list view featured by the map and bounding box filter for the geo-based data of the GeoDjango.

Django Query Capture can check the query situation at a glance, notice slow queries, and notice where N+1 occurs.

Django-Audiofield is a simple app that allows Audio files upload, management and conversion to different audio format (mp3, wav & ogg), which also makes it easy to play audio files into your Django application.

Automatically deletes old file for FileField and ImageField. It also deletes files on models instance deletion.

Transparently use webpack with django

Wagtail - Vue - Django : The initial environment of full-stack local dev web app with wagtail and vue

Full control of form rendering in the templates.

A real-time photo feed using Django and Pusher

Quick example of a todo list application using Django and HTMX

A slick ORM cache with automatic granular event-driven invalidation.

Django CacheMiddleware has a multi-threading issue with pylibmc

A feature flipper for Django

A Student/ School management application built using Django and Python.

Simple alternative to Doodle polls and scheduling (Python 3, Django 3, JavaScript)

Probably the best abstract model / admin for your tree based stuff.

Customize the behavior of django.contrib.auth permissions.

Pipeline is an asset packaging library for Django.

Simple web site for sharing your short stories and beautiful pictures

scaffold django rest apis like a champion 🚀