Add in docs: How to use reversion in a management command. about django-reversion HOT 12 CLOSED

I think this is covered in the LowLevelAPI wiki section. It's really just a case of

# Insert management comment boilerplate...
with reversion.revision:
    your_model.save()

from django-reversion.

I tried this, but it doesn't work. No new version saved and no error.

But i found the failure: I only registered my model with VersionAdmin. In this case it's needed to register the model in models.py, isn't it?

So it's a good idea to clarify this in LowLevelAPI wiki page?

from django-reversion.

If you register with VersionAdmin, then you just need to import the relevant
admin.py file.

Yeah, a little clarification wouldn't go amis here. I'll put it in.

No error is the correct behaviour, though, as it's quite correct to save
models within the scope of a revision that aren't intended for version
control.

I tried this, but it doesn't work. No new version saved and no error.

But i found the failure: I only registered my model with VersionAdmin. In
this case it's needed to register the model in models.py, isn't it?

So it's a good idea to clarify this in LowLevelAPI wiki page?

Reply to this email directly or view it on GitHub:
#63 (comment)

Dave Hall
Etianen.com

Telephone: 07525 452381
Web: http://www.etianen.com

from django-reversion.

Btw. How to add a comment to this?

I tried:

with reversion.revision:
    reversion.comment = "one"
    your_model.save()

and:

with reversion.revision:
    your_model.save()
    reversion.comment = "two"

But no comment saved.

from django-reversion.

To quote the LowLevelApi wiki:

It is possible to attach a comment and a user reference to an active revision using the following method:

    @revision.create_on_success
    def your_view(request):
        your_model.save()
        # Set the revision meta data.
        revision.user = me
        revision.comment = "Doing some changes..."

from django-reversion.

OK, it only works with create_on_success decorator, but not with "with" statement? Good idea to put this to docs, too ;)

from django-reversion.

I tried @revision.create_on_success in a management command. A new reversion saved, but without comment.

from django-reversion.

Here is a example of my command: https://gist.github.com/1037609

from django-reversion.

It's revision.comment, not reversion.comment

from django-reversion.

Ah! That's it. Thank you.

Foolish that's the words are so similar. ;)

from django-reversion.

Heh, I'll take a look at the docs and try to make things easier! :P

from django-reversion.

I've added in some clarification to the docs.

from django-reversion.