Skip to main content

A model instances generator for Django

Project description

https://travis-ci.org/fcurella/django-fakery.svg?branch=master https://coveralls.io/repos/fcurella/django-fakery/badge.svg?branch=master&service=github

An easy-to-use implementation of Creation Methods for Django, backed by Faker.

django_fakery will try to guess the field’s value based on the field’s name and type.

QuickStart

from django_fakery.factory import factory

factory.make('auth.User', quantity=4)

Lazies

You can refer to the created instance’s own field by using Lazy objects.

For example, if you’d like to create user with email as username, and have them always match, you could do:

from django_fakery.lazy import Lazy

factory.make(
    'auth.User',
    username=Lazy('email')
)

Blueprints

from django_fakery.blueprint import Blueprint

user = Blueprint('auth.User')

user.make(quantity=10)

If you want to ensure uniqueness when generating multiple objects, you can use a lambda function.

In this example, n is the iteration number, and f is an instance of faker:

user = Blueprint(
    'auth.User',
    fields={
        'username': lambda n, f: 'user_%s' % n,
    }
)

For convenience, when the value is a string, you can simply pass a formatting string:

user = Blueprint(
    'auth.User',
    fields={
        'username': 'user_%(n)s',
    }
)

Blueprints can refer other blueprints:

pizza = Blueprint(
    'food.Pizza',
    fields={
        'chef': user,
    }
)

Seeding the faker

from django_fakery.factory import Factory

factory = Factory()

factory.seed(1234)

factory.make('auth.User', fields={
    'username': 'regularuser'
}, seed=1234, quantity=4)
from django_fakery.factory import factory

factory.make('auth.User', fields={
    'username': 'regularuser'
}, seed=1234, quantity=4)

TODO

  • lazy methods

  • post-creation hooks

  • callable shortcuts in bluprints

  • contrib fields

  • localization

  • self-referencing models

License

This software is released under the MIT License.

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-fakery-0.0.4.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

django_fakery-0.0.4-py2.py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 2 Python 3

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