techscientist / django-orm-magic

An extension for IPython that help to define and use django's models on the fly

Django ORM Magic

author

Martín Gaitán <[email protected]>

homepage

https://github.com/mgaitan/django-orm-magic

documentation

see this notebook

Define your django models in an IPython cell and use them on the fly. Let the magic do the boring part.

Django ORM isn't conceived to be used standalone. Even for a trivial case, you need to configure a database, create an app, etc. This magic handle that automatically, and then import every model to your interactive session.

Install

You can install or upgrade via pip

pip install -U django-orm-magic

or directly from the repository using the %install_ext magic command:

In[1]: %install_ext https://raw.github.com/mgaitan/django-orm-magic/master/django_orm_magic.py

Basic usage

Once it's installed, you can load it with %load_ext django_orm_magic. Then define your models in a cell started with the cell magic %%django_orm. For example:

In[2]: %load_ext django_orm_magic


In[3]: %%django_orm

       from django.db import models

       class Poll(models.Model):
           question = models.CharField(max_length=200)
           pub_date = models.DateTimeField('date published')

       class Choice(models.Model):
           poll = models.ForeignKey(Poll)
           choice_text = models.CharField(max_length=200)
           votes = models.IntegerField(default=0)

And it's done. Every model is synced in a sqlite database named db.sqlite in your current path and imported automatically:

In[4]: Poll.objects.all()
Out[4]: []

In[5]: from django.utils import timezone
       p = Poll(question="What's new?", pub_date=timezone.now())
       p.save()

See the documentation for further details.

See here for another example