django-ctct 0.0.1.dev4__tar.gz → 0.0.1.dev6__tar.gz

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev6}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: django-ctct
-Version: 0.0.1.dev4
+Version: 0.0.1.dev6
 Summary: A Django interface for the Constant Contact API
 License: MIT
+License-File: LICENSE
 Author: Geoffrey Eisenbarth
 Author-email: geoffrey.eisenbarth@gmail.com
 Requires-Python: >=3.10
@@ -12,7 +13,9 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: django (>=3.2.0,<6.0.0)
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: django (>=4.2)
+Requires-Dist: mypy (>=1.19.0,<2.0.0)
 Requires-Dist: pyjwt[crypto] (>=2.10.1,<3.0.0)
 Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
@@ -25,7 +28,9 @@ Description-Content-Type: text/markdown
 
 This Django app provides a seamless interface to the Constant Contact API, allowing you to manage contacts, email campaigns, and other Constant Contact functionalities directly from your Django project.
 
-**Warning:** This package is under active development. While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+**Warning:** This package is under active development.
+While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+
 
 ## Installation
 
@@ -33,6 +38,7 @@ This Django app provides a seamless interface to the Constant Contact API, allow
 pip install django-ctct
 ```
 
+
 ## Configuration
 
 1) **Add to `INSTALLED_APPS`:**
@@ -61,6 +67,7 @@ urlpatterns = [
   # ... other URL patterns
 ]
 ```
+
 3) **ConstantContact API Credentials:**
 
 Head to https://app.constantcontact.com/pages/dma/portal/ to set up your application with ConstantContact.
@@ -110,17 +117,19 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
   * `CTCT_PREVIEW_MESSAGE` will be blank by default.
 
 3) **Run Migrations:**
+
 ```bash
 > ./manage.py makemigrations
 > ./manage.py migrate
 ```
 
-4) **Create Authenticatin Token:**
+4) **Create Authentication Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
-  * Open up the `CTCT_REDIRECT_URI` address in your browser
-  * Use your ConstantContact credentials to log in
-  * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
+
+ * Open up the `CTCT_REDIRECT_URI` address in your browser
+ * Use your ConstantContact credentials to log in
+ * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
 
 
 ## Usage
@@ -130,12 +139,16 @@ If you wish to import data from ConstantContact.com into your local database (re
 > ./manage.py import_ctct
 ```
 
-You will be asked before each model type is imported. **Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
+You will be asked before each model type is imported.
+**Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
 
-Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database. You can use the `--no-input` flag to bypass the interactive questions. The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
+Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database.
+You can use the `--no-input` flag to bypass the interactive questions.
+The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
 
 If you wish to use the Django admin to interact with ConstantContact, you must explicitly set the `CTCT_USE_ADMIN` and `CTCT_SYNC_ADMIN` settings to `True`.
 
+
 ## Testing
 
 To install dev dependencies:
@@ -155,13 +168,13 @@ To run tests:
 > poetry run coverage report
 ```
 
+
 ## Contributing
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
-  * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc). This will be controlled by the `CTCT_SYNC_SIGNALS` setting. **Update** This probably won't work as desired since the primary object will be saved before related objects are.
-  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
-  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
+ * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
+ * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   
 
 I'm always open to new suggestions, so please reach out on GitHub: https://github.com/geoffrey-eisenbarth/django-ctct/

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev6}/README.md

@@ -4,7 +4,9 @@
 
 This Django app provides a seamless interface to the Constant Contact API, allowing you to manage contacts, email campaigns, and other Constant Contact functionalities directly from your Django project.
 
-**Warning:** This package is under active development. While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+**Warning:** This package is under active development.
+While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+
 
 ## Installation
 
@@ -12,6 +14,7 @@ This Django app provides a seamless interface to the Constant Contact API, allow
 pip install django-ctct
 ```
 
+
 ## Configuration
 
 1) **Add to `INSTALLED_APPS`:**
@@ -40,6 +43,7 @@ urlpatterns = [
   # ... other URL patterns
 ]
 ```
+
 3) **ConstantContact API Credentials:**
 
 Head to https://app.constantcontact.com/pages/dma/portal/ to set up your application with ConstantContact.
@@ -89,17 +93,19 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
   * `CTCT_PREVIEW_MESSAGE` will be blank by default.
 
 3) **Run Migrations:**
+
 ```bash
 > ./manage.py makemigrations
 > ./manage.py migrate
 ```
 
-4) **Create Authenticatin Token:**
+4) **Create Authentication Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
-  * Open up the `CTCT_REDIRECT_URI` address in your browser
-  * Use your ConstantContact credentials to log in
-  * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
+
+ * Open up the `CTCT_REDIRECT_URI` address in your browser
+ * Use your ConstantContact credentials to log in
+ * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
 
 
 ## Usage
@@ -109,12 +115,16 @@ If you wish to import data from ConstantContact.com into your local database (re
 > ./manage.py import_ctct
 ```
 
-You will be asked before each model type is imported. **Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
+You will be asked before each model type is imported.
+**Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
 
-Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database. You can use the `--no-input` flag to bypass the interactive questions. The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
+Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database.
+You can use the `--no-input` flag to bypass the interactive questions.
+The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
 
 If you wish to use the Django admin to interact with ConstantContact, you must explicitly set the `CTCT_USE_ADMIN` and `CTCT_SYNC_ADMIN` settings to `True`.
 
+
 ## Testing
 
 To install dev dependencies:
@@ -134,13 +144,13 @@ To run tests:
 > poetry run coverage report
 ```
 
+
 ## Contributing
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
-  * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc). This will be controlled by the `CTCT_SYNC_SIGNALS` setting. **Update** This probably won't work as desired since the primary object will be saved before related objects are.
-  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
-  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
+ * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
+ * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   
 
 I'm always open to new suggestions, so please reach out on GitHub: https://github.com/geoffrey-eisenbarth/django-ctct/

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev6}/django_ctct/admin.py

@@ -1,12 +1,11 @@
 import functools
-from typing import TypeVar, ParamSpec, Generic, Optional, Callable, Iterable
+from typing import TypeVar, ParamSpec, Generic, Callable, Iterable
 from requests.exceptions import HTTPError
 
 from django import forms
 from django.conf import settings
 from django.contrib import admin, messages
 from django.contrib.auth import get_user_model
-from django.db.models import signals
 from django.db.models import Model, QuerySet, When, Case, F, FloatField
 from django.db.models.functions import Cast
 from django.forms import ModelForm, BaseFormSet
@@ -24,7 +23,6 @@ from django_ctct.models import (
   EmailCampaign, CampaignActivity, CampaignSummary,
 )
 from django_ctct.signals import remote_save, remote_delete
-from django_ctct.vendor import mute_signals
 
 
 P = ParamSpec('P')
@@ -51,7 +49,7 @@ def catch_api_errors(func: Callable[P, None]) -> Callable[P, None]:
       if getattr(settings, 'CTCT_RAISE_FOR_API', False):
         raise e
       else:
-        self, request, *_ = args
+        self, request, *x = args
         assert isinstance(self, admin.ModelAdmin)
         assert isinstance(request, HttpRequest)
         self.message_user(
@@ -81,7 +79,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_add_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Prevent creation in the Django admin."""
     return False
@@ -89,7 +87,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_change_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Prevent updates in the Django admin."""
     return False
@@ -97,7 +95,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> tuple[str, ...]:
     """Prevent updates in the Django admin."""
     if obj is not None:
@@ -113,7 +111,7 @@ class ViewModelAdmin(admin.ModelAdmin[Model]):
   def has_delete_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Allow superusers to delete objects."""
     return request.user.is_superuser
@@ -124,35 +122,30 @@ class RemoteModelAdmin(
 ):
   """Facilitate remote saving and deleting."""
 
-  # ChangeView
-  @property
-  def remote_sync(self) -> bool:
-    sync_admin = getattr(settings, 'CTCT_SYNC_ADMIN', False)
-    sync_signals = getattr(settings, 'CTCT_SYNC_SIGNALS', False)
-    return sync_admin and not sync_signals
+  sync_admin: bool = getattr(settings, 'CTCT_SYNC_ADMIN', False)
 
+  # ChangeView
   @catch_api_errors
   def delete_model(self, request: HttpRequest, obj: Model) -> None:
     obj.delete()
-    if self.remote_sync:
+    if self.sync_admin:
       remote_delete(sender=self.model, instance=obj)
 
   @catch_api_errors
   def delete_queryset(
     self,
     request: HttpRequest,
-    queryset: QuerySet[CTCTEndpointModel],
+    queryset: QuerySet[E],
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
       queryset.model.remote.bulk_delete(queryset)
-    with mute_signals(signals.pre_delete):
-      queryset.delete()
+    queryset.delete()
 
   @catch_api_errors
   def save_related(
     self,
     request: HttpRequest,
-    form: ModelForm[CTCTEndpointModel],
+    form: ModelForm[E],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
@@ -164,9 +157,8 @@ class RemoteModelAdmin(
     for saving objects remotely.
 
     """
-    with mute_signals(signals.m2m_changed):
-      # ManyToMany information is sent to CTCT in PUT call
-      form.save_m2m()
+    # ManyToMany information is sent to CTCT in PUT call
+    form.save_m2m()
     for formset in formsets:
       self.save_formset(request, form, formset, change=change)
     self.save_remotely(request, form, formsets, change)
@@ -175,11 +167,11 @@ class RemoteModelAdmin(
   def save_remotely(
     self,
     request: HttpRequest,
-    form: ModelForm[CTCTEndpointModel],
+    form: ModelForm[E],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
       # Remote save the primary object after related objects have been saved
       remote_save(
         sender=self.model,
@@ -285,7 +277,7 @@ class ContactNoteInline(admin.TabularInline[ContactNote, Contact]):
   def has_change_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Contact] = None,  # type: ignore[override]
+    obj: Contact | None = None,  # type: ignore[override]
   ) -> bool:
     return False
 
@@ -295,7 +287,7 @@ class ContactCustomFieldInline(
 ):
 
   model = ContactCustomField
-  excldue = ('api_id', )
+  exclude = ('api_id', )
 
   extra = 0
 
@@ -370,7 +362,7 @@ class ContactAdmin(RemoteModelAdmin[Contact]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[Contact] = None,
+    obj: Contact | None = None,
   ) -> list[str]:
     readonly_fields = list(Contact.API_READONLY_FIELDS)
     if obj and obj.opt_out_source and not request.user.is_superuser:
@@ -401,9 +393,8 @@ class ContactAdmin(RemoteModelAdmin[Contact]):
         instance.author = request.user
       instance.save()
 
-    with mute_signals(signals.m2m_changed):
-      # ManyToMany information is sent to CTCT in PUT call
-      formset.save_m2m()
+    # ManyToMany information is sent to CTCT in PUT call
+    formset.save_m2m()
 
 
 class ContactNoteAuthorFilter(admin.SimpleListFilter):
@@ -416,7 +407,7 @@ class ContactNoteAuthorFilter(admin.SimpleListFilter):
     self,
     request: HttpRequest,
     model_admin: admin.ModelAdmin[Model],
-  ) -> Optional[Iterable[tuple[str, str]]]:
+  ) -> Iterable[tuple[str, str]] | None:
     authors = get_user_model().objects.exclude(notes__isnull=True)
     return [(str(obj.id), str(obj)) for obj in authors]
 
@@ -473,7 +464,7 @@ class ContactNoteAdmin(RemoteSyncMixin, ViewModelAdmin):
   def has_delete_permission(
     self,
     request: HttpRequest,
-    obj: Optional[Model] = None,
+    obj: Model | None = None,
   ) -> bool:
     """Allow superusers to delete Notes."""
     return request.user.is_superuser
@@ -516,7 +507,7 @@ class CampaignActivityInline(
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[CampaignActivity] = None,
+    obj: CampaignActivity | None = None,
   ) -> list[str]:
     readonly_fields = list(CampaignActivity.API_READONLY_FIELDS)
     if obj and obj.current_status == 'DONE':
@@ -559,7 +550,7 @@ class EmailCampaignAdmin(RemoteModelAdmin[EmailCampaign]):
   def get_readonly_fields(
     self,
     request: HttpRequest,
-    obj: Optional[EmailCampaign] = None,
+    obj: EmailCampaign | None = None,
   ) -> list[str]:
     readonly_fields = list(EmailCampaign.API_READONLY_FIELDS)
     if obj and obj.current_status == 'DONE':
@@ -570,20 +561,20 @@ class EmailCampaignAdmin(RemoteModelAdmin[EmailCampaign]):
   def save_remotely(
     self,
     request: HttpRequest,
-    form: ModelForm[EmailCampaign],  # type: ignore[override]
+    form: ModelForm[EmailCampaign],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
-    if self.remote_sync:
+    if self.sync_admin:
 
       campaign = form.instance
       activity = formsets[0][0].instance
 
       # Handle remote saving the EmailCampaign
+      # NOTE: The only EmailCampaign field that can be updated is 'name'
       campaign_created = not change
       campaign_updated = change and ('name' in form.changed_data)
       if campaign_created or campaign_updated:
-        # The only EmailCampaign field that can be updated is 'name'
         remote_save(
           sender=self.model,
           instance=campaign,

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev6}/django_ctct/apps.py

@@ -1,5 +1,4 @@
 from django.apps import AppConfig
-from django.db.models.signals import post_save, m2m_changed, pre_delete
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.translation import gettext_lazy as _
@@ -24,12 +23,3 @@ class CTCTConfig(AppConfig):
           f"[django-ctct] {value} must be defined in settings.py."
         )
         raise ImproperlyConfigured(message)
-
-    # Hook up the signals
-    from django_ctct.signals import (
-      remote_save, remote_delete, remote_update_m2m
-    )
-    if getattr(settings, 'CTCT_SYNC_SIGNALS', False):
-      post_save.connect(remote_save)
-      pre_delete.connect(remote_delete)
-      m2m_changed.connect(remote_update_m2m)