Skip to main content

Automatically generate reasonable database entries for your app

Project description


Django-Scaffolding creates pseudo-real-world placeholder data for your app. Data can be any type like names, cities, images and instances of your models. It’s not a mocking framework, it creates real django model instances.


Create a module within your app directory which contains the Scaffolding classes.


class Entry(models.Model):
    first_name = models.CharField('First Name', max_length=32)
    last_name = models.CharField('Last Name', max_length=32)
    comment = models.TextField('Comment')
    image = models.ImageField(upload_to='uploads/%Y/%m/%d', blank=True, null=True)
    contest = models.ForeignKey(Contest)


import scaffolding
from import FlickrInteresting

class EntryScaffold(object):
    first_name = scaffolding.FirstName(max_length=32)
    last_name = scaffolding.LastName(max_length=32)
    comment = scaffolding.LoremIpsum(paragraphs=1)
    contest = scaffolding.ForeignKey(queryset=Contest.objects.filter(name='testcontest'))
    image = scaffolding.RandomInternetImage(backend=FlickrInteresting)

scaffolding.register(Entry, EntryScaffold)

Mind the syntax for ForeignKey fields. You can assign an integer to the field but make sure the element with the corresponding key does exist. Of course you can also assign an object to the FK field.

To use the flickr library you need to have the Flickr API: installed.

Run the management command to create the data: scaffold myapp.MyModel 20

The number stands for the amout of entries to be created.

Using scaffolding in interpreter or views

You can try out the included classes or your own modules in the shell. All classes are generators (called Tubes) that generate the field’s values. start ./ shell:

>>> from scaffolding import *
>>> r = RandInt(min=1, max=5)

>>> n = Name(gender='m')
[u'Ethan Schmid']
[u'Michael Schneider']

Included Tubes


Generates a random name. <gender> can be ‘male’, ‘female’, ‘m’ or ‘f’.


Generates a Lorem Ipsum Text. The number of paragraphs is defined in paragraphs.


Generates a random integer between min and max.


Takes a queryset and iterates through it. Assigns the item as ForeignKeys to the field. Wraps around if there are not enough items.


The same for nullable ForeignKeys. split is the weight for positives. 0.2 yields 80% None.


Creates a random image for an ImageField using an internet source. A Flickr ‘Daily Interesting images’ grabber is included.


Returns True


Returns False


Randomly returns true or false. You can set a ratio for true or false by specifying true or false: e.g. false=3 returns 3 times as many False than Trues.


Takes one argument value and assigns it to the field.


Takes a list (not an iterable) as its lst argument and returns an element from it.

Every Value

Takes an iterable as its values argument and loops through them in order.


This is a special tube that takes another tube as its first argument. It assigns a value from the passed class or None. This is useful for nullable fields. You can pass the arguments for the wrapped class as arguments to the OrNone class. There is one additional argument: split. This defines a ratio of useful to None. A ratio of 0.2 will give you 80% None.


The same as OrNone, but uses a blank string instead of None. Ideal for text fields that have blank=True.


Creates a random date between startdate and enddate. startdate and enddate have to be instances.


Returns a name of a US city and state. e.g. “New York, NY”.


Crates a Custom Object. The backend class is the first parameter. The backend class has to inherit from Tube:

user = scaffolding.Contrib(FacebookTestUser, app_name='contest')


Creates a Facebook User from the test users pool of the Facebook app. If there aren’t enough test users new ones are automatically created. This requires the django-facebook-graph API.

The module is in external.facebook_graph.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-scaffolding-0.2.1.tar.gz (12.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page