Add documentation for skips, bump release version.

Author: ses4j

README.md

@@ -70,6 +70,10 @@ Combine bulk create, update, and delete. Make the DB match a set of in-memory ob
 -   `filters`: Q() filters specifying the subset of the database to work in. Use `None` or `[]` if you want to sync against the entire table.
 -   `batch_size`: passes through to Django `bulk_create.batch_size` and `bulk_update.batch_size`, and controls how many objects are created/updated per SQL query.
 -   `fields`: (optional) List of fields to update. If not set, will sync all fields that are editable and not auto-created.
+-   `skip_creates`: If truthy, will not perform any object creations needed to fully sync. Defaults to not skip.
+-   `skip_updates`: If truthy, will not perform any object updates needed to fully sync. Defaults to not skip. 
+-   `skip_deletes`: If truthy, will not perform any object deletions needed to fully sync. Defaults to not skip. 
+
 -   Returns a dict:
 
     {

bulk_sync/__init__.py

@@ -15,7 +15,9 @@ def bulk_sync(new_models, key_fields, filters, batch_size=None, fields=None, ski
     `batch_size`: passes through to Django `bulk_create.batch_size` and `bulk_update.batch_size`, and controls
             how many objects are created/updated per SQL query.
     `fields`: (optional) list of fields to update. If not set, will sync all fields that are editable and not auto-created.
-
+    `skip_creates`: If truthy, will not perform any object creations needed to fully sync. Defaults to not skip.
+    `skip_updates`: If truthy, will not perform any object updates needed to fully sync. Defaults to not skip. 
+    `skip_deletes`: If truthy, will not perform any object deletions needed to fully sync. Defaults to not skip. 
     """
     db_class = new_models[0].__class__
 
@@ -49,13 +51,13 @@ def get_key(obj):
                 new_obj.id = old_obj.id
                 existing_objs.append(new_obj)
 
-        if skip_creates is False:
+        if not skip_creates:
             db_class.objects.bulk_create(new_objs, batch_size=batch_size)
 
-        if skip_updates is False:
+        if not skip_updates:
             db_class.objects.bulk_update(existing_objs, fields=fields, batch_size=batch_size)
 
-        if skip_deletes is False:
+        if not skip_deletes:
             # delete stale objects
             objs.filter(pk__in=[_.pk for _ in list(obj_dict.values())]).delete()
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="django-bulk-sync",
-    version='2.0.0',
+    version='2.1.0',
     description="Combine bulk add, update, and delete into a single call.",
     long_description=long_description,
     long_description_content_type='text/markdown',