Metadata-Version: 1.0
Name: django-fixture-magic
Version: 0.0.3
Summary: A few extra management tools to handle fixtures.
Home-page: http://github.com/davedash/django-fixture-magic
Author: Dave Dash
Author-email: dd+pypi@davedash.com
License: BSD
Description: ============
        Requirements
        ============
        
        This package requires:
        
            * Python 2.6
            * Django
        
        
        Installation
        ------------
        
        You can get fixture-magic from pypi with: ::
        
            pip install django-fixture-magic
        
        The development version can be installed with: ::
        
            pip install -e git://github.com/davedash/django-fixture-magic#egg=django_fixture_magic
        
        fixture-magic adds two commands to ``manage.py`` therefore you should add it to
        your ``INSTALLED_APPS`` in ``settings.py``: ::
        
            INSTALLED_APPS = (
                ...
                'fixture_magic',
                ...
            )
        
        Usage
        -----
        
        There are four commands.  ``dump_object`` returns the json representation of
        a specific object as well as all its dependencies (as defined by ForeignKeys).
        
            ./manage.py dump_object APP.MODEL PK1 PK2 PK3 ... > my_new_fixture.json
        
        You can now safely load ``my_new_fixture.json`` in a test without foreign key i
        errors.
        
        The second command is ``merge_fixtures``.  This command takes several fixture
        files and does a simple de-dupe operation (based on model and pk) and returns a
        clean json file.  This is helpful if you have multiple json fixtures that might
        have redundant data.
        
            ./manage.py merge_fixtures fixture1.json fixture2.json fixture3.json ... \
            > all_my_fixtures.json
        
        The third command is ``reorder_fixtures``.  This command takes a single file
        and several model names (in ``app.model`` format as they are specified in
        fixture files).  This reorders your fixtures so the models you specifiy first
        show up in the fixture first.  This is helpful if you tend to get foreign-key
        errors when loading models.
        
            ./manage.py reorder_fixtures fixture.json APP1.MODEL1 APP2.MODEL2 ... \
            > ordered_fixture.json
        
        Unspecified models will be appended to the end.
        
        The fourth command is ``custom_dump``.  This reads a setting ``CUSTOM_DUMPS``:
        
        ::
        
            ## Fixture Magic
            CUSTOM_DUMPS = {
                'addon': {  # Initiate dump with: ./manage.py custom_dump addon id
                    'primary': 'addons.addon',  # This is our reference model.
                    'dependents': [  # These are the attributes/methods of the model that we wish to dump.
                        'current_version',
                        'current_version.files.all.0',
                    ],
                    'order': ('app1.model1', 'app2.model2',),
                    'order_cond': {'app1.model1': lambda x: 1 if x.get('fields').get('parent_model1') else 0,
                                    'app2.model2': lambda x: -1 * x.get('pk')},
                }
            }
        
        It runs the equivalent of ``dump_object`` on the dependents (which in turn pick
        up the primary object).  The JSON dumps are then merged together.  Very handy
        for dumping multi-dependent objects. `dependents`, `order` and `order_cond` are
        optional.
        
        `dependents`: Defines additional properties/methods to dump the return values
        of. Magic will convert `"current_version.files.all.0"`
        to `object.current_version.files.all()[0]`
        
        `order`: Specify an order in which objects should be dumped based on their
        model class. In the above example, all app1.model1 objects will preceed any
        app2.model2 objects, which will preceed any objects of any other model class.
        
        `order_cond`: Specify an order to dump objects of one or more particular model
        classes. In the above example, all app1.model1 objects with a truthy
        `self.parent_model1` attribute will come after any other app1.model1 object that
        does not have a truthy value for this attribute. A sort operation is called on
        the list of all objects of that model type, with the value associated with a
        model name being passed to the sort function as the `key` keyword argument.
        Keep in mind that the model objects will have already been serialized to a
        dictionary object prior to the sort operation.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
