From cea9c3d2ea39c872ecbccb8510cd076dee4f348b Mon Sep 17 00:00:00 2001 From: hassaanalansary Date: Sun, 28 May 2023 15:30:16 +0300 Subject: [PATCH] Update documentation to show that inheriting from BulkTrackerQuerySet is optional --- docs/source/usage.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index b89ff2b..442ed3e 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -16,12 +16,21 @@ and single operations: - ``save() # update and create`` - ``delete()`` -all you need to do is to define your queryset and inherit from:: +all you need to do is to define your Model and inherit from:: + + from bulk_tracker.models import BulkTrackerModel + + class Author(BulkTrackerModel): + first_name = models.CharField(max_length=200) + last_name = models.CharField(max_length=200) + +OR if you have a custom queryset inherit from or Don't want to support single-operation:: from bulk_tracker.managers import BulkTrackerQuerySet class MyModelQuerySet(BulkTrackerQuerySet): - pass + def do_something_custom(self): + pass now you can listen to the signals ``post_update_signal``, ``post_create_signal``, ``post_delete_signal``:: @@ -113,14 +122,14 @@ Complete Example :: # managers.py - from bulk_tracker.managers import BulkTrackerQuerySet + from bulk_tracker.managers import BulkTrackerQuerySet # optional class MyModelQuerySet(BulkTrackerQuerySet): pass - class MyModelManager(BulkTrackerManager.from_queryset(MyModelQuerySet)): + class MyModelManager(BulkTrackerManager.from_queryset(MyModelQuerySet)): # optional pass ::