Added documentation/changelog for #16, and blacked repo.

Author: ses4j

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Added
+
+-   Added exclude_fields argument. Issue #15, pull request #16 from [@VKFisher](https://github.com/VKFisher).
+
 ## [3.0.1] - 2020-08-05
 
 ### Updated

README.md

@@ -74,6 +74,7 @@ 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`: (optional) 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.
+-   `exclude_fields`: (optional) list of fields to exclude from updates. Subtracts from the passed-in `fields` or default-calculated `fields` (see `fields` documentation above).
 -   `exclude_fields`: (optional) List of fields to exclude from updates.
 -   `skip_creates`: (optional) If truthy, will not perform any object creations needed to fully sync. Defaults to not skip.
 -   `skip_updates`: (optional) If truthy, will not perform any object updates needed to fully sync. Defaults to not skip.

bulk_sync/__init__.py

@@ -29,7 +29,8 @@ def bulk_sync(
             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.
-    `exclude_fields`: (optional) list of fields to exclude from updates.
+    `exclude_fields`: (optional) list of fields to exclude from updates. Subtracts from the passed-in `fields` or
+            default-calculated `fields` (see `fields` documentation above.)
     `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.

runtest.py

@@ -4,7 +4,7 @@
 import django
 
 if __name__ == "__main__":
-    os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.test_settings'
+    os.environ["DJANGO_SETTINGS_MODULE"] = "tests.test_settings"
 
     from django.conf import settings
     from django.test.utils import get_runner
@@ -15,4 +15,3 @@
     test_runner = TestRunner()
     failures = test_runner.run_tests(["tests"])
     sys.exit(bool(failures))
-    

tests/test_settings.py

@@ -3,15 +3,13 @@
 
 BASE_DIR = os.path.join(os.path.dirname(os.path.dirname(__file__)), os.pardir)
 
-SECRET_KEY = 'testsecretkey43u2894u329h432nuhrn32iu'
+SECRET_KEY = "testsecretkey43u2894u329h432nuhrn32iu"
 DEBUG = True
 
 db_url = os.environ.get("DATABASE_URL", "sqlite://localhost/:memory:")
 DB = dj_database_url.parse(db_url)
 
-DATABASES = {
-    'default': DB,
-}
+DATABASES = {"default": DB}
 
-INSTALLED_APPS = ('bulk_sync', 'tests',)
+INSTALLED_APPS = ("bulk_sync", "tests")
 MIDDLEWARE_CLASSES = ()