django-ctct 0.0.1.dev5__tar.gz → 0.0.1.dev7__tar.gz

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev7}/PKG-INFO

@@ -1,25 +1,16 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: django-ctct
-Version: 0.0.1.dev5
+Version: 0.0.1.dev7
 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
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: django (>=3.2.0,<6.0.0)
-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)
-Requires-Dist: tqdm (>=4.67.1,<5.0.0)
+Author-email: Geoffrey Eisenbarth <geoffrey.eisenbarth@gmail.com>
+License: MIT
+Requires-Dist: django>=6.0
+Requires-Dist: requests>=2.32.3,<3.0.0
+Requires-Dist: ratelimit>=2.2.1,<3.0.0
+Requires-Dist: tqdm>=4.67.1,<5.0.0
+Requires-Dist: pyjwt[crypto]>=2.10.1,<3.0.0
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
 # Constant Contact Integration for Django
@@ -48,7 +39,7 @@ In your Django project's settings.py file, add `'django_ctct'` to the `'INSTALLE
 ```python
 INSTALLED_APPS = [
   # ... django apps
-  'django_ctct',
+  "django_ctct",
   # ... other apps
 ]
 ```
@@ -62,8 +53,8 @@ from django.contrib import admin
 from django.urls import path, include
 
 urlpatterns = [
-  path('admin/', admin.site.urls),
-  path('django-ctct/', include('django_ctct.urls')),
+  path("admin/", admin.site.urls),
+  path("django-ctct/", include("django_ctct.urls")),
   # ... other URL patterns
 ]
 ```
@@ -84,28 +75,30 @@ CTCT_REDIRECT_URI = "REDIRECT_URI_FROM_CTCT"
 CTCT_FROM_NAME = "YOUR_EMAIL_NAME"
 CTCT_FROM_EMAIL = "YOUR_EMAIL_ADDRESS"
 
-# Optional settings
+# Optional settings, callables will receive the EmailCampaign object as an argument
 CTCT_REPLY_TO_EMAIL = "YOUR_REPLY_TO_ADDRESS"
 CTCT_PHYSICAL_ADDRESS = {
-  'address_line1': '1060 W Addison St',
-  'address_line2': '',
-  'address_optional': '',
-  'city': 'Chicago',
-  'country_code': 'US',
-  'country_name': 'United States',
-  'organization_name': 'Wrigley Field',
-  'postal_code': '60613',
-  'state_code': 'IL',
+  "address_line1": "1060 W Addison St",
+  "address_line2": "",
+  "address_optional": "",
+  "city": "Chicago",
+  "country_code": "US",
+  "country_name": "United States",
+  "organization_name": "Wrigley Field",
+  "postal_code": "60613",
+  "state_code": "IL",
 }
 CTCT_PREVIEW_RECIPIENTS = (
-  ('First Recipient', 'first@recipient.com'),
-  ('Second Recipient', 'second@recipient.com'),
+  ("First Recipient", "first@recipient.com"),
+  ("Second Recipient", "second@recipient.com"),
 )
+CTCT_PREVIEW_RECIPIENTS_CALLABLE = "myproject.myapp.ctct.get_preview_recipients"
 CTCT_PREVIEW_MESSAGE = "This is an EmailCampaign preview."
+CTCT_PREVIEW_MESSAGE_CALLABLE = "myproject.myapp.ctct.get_preview_message"
 
 # Optional functionality settings and their default settings
-CTCT_USE_ADMIN = False       # Add django-ctct models to admin
-CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct account
+CTCT_USE_ADMIN = False  # Add django-ctct models to admin
+CTCT_SYNC_ADMIN = False  # Django admin CRUD operations will sync with ctct account
 ```
 
 **Important:** Store your API credentials securely. Avoid committing them directly to your version control repository.
@@ -123,7 +116,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 > ./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:
 
@@ -156,16 +149,22 @@ To install dev dependencies:
 ```bash
 > git clone git@github.com:geoffrey-eisenbarth/django-ctct.git
 > cd django-ctct
-> python -m pip install --upgrade pip
-> pip intall poetry
-> poetry install --with dev
+> curl -LsSf https://astral.sh/uv/install.sh | sh
+> uv sync --group dev
 ```
 
 To run tests:
 
 ```bash
-> poetry run coverage run tests/project/manage.py test
-> poetry run coverage report
+> uv run coverage run tests/project/manage.py test
+> uv run coverage report
+```
+
+To lint and format:
+
+```bash
+> uv run ruff check .
+> uv run ruff format .
 ```
 
 
@@ -173,9 +172,6 @@ To run tests:
 
 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.
   
@@ -191,4 +187,3 @@ This package is currently distributed under the MIT license.
 ## Support
 
 If you have any issues or questions, please feel free to reach out to me on GitHub: https://github.com/geoffrey-eisenbarth/django-ctct/issues
-

{django_ctct-0.0.1.dev5 → django_ctct-0.0.1.dev7}/README.md

@@ -24,7 +24,7 @@ In your Django project's settings.py file, add `'django_ctct'` to the `'INSTALLE
 ```python
 INSTALLED_APPS = [
   # ... django apps
-  'django_ctct',
+  "django_ctct",
   # ... other apps
 ]
 ```
@@ -38,8 +38,8 @@ from django.contrib import admin
 from django.urls import path, include
 
 urlpatterns = [
-  path('admin/', admin.site.urls),
-  path('django-ctct/', include('django_ctct.urls')),
+  path("admin/", admin.site.urls),
+  path("django-ctct/", include("django_ctct.urls")),
   # ... other URL patterns
 ]
 ```
@@ -60,28 +60,30 @@ CTCT_REDIRECT_URI = "REDIRECT_URI_FROM_CTCT"
 CTCT_FROM_NAME = "YOUR_EMAIL_NAME"
 CTCT_FROM_EMAIL = "YOUR_EMAIL_ADDRESS"
 
-# Optional settings
+# Optional settings, callables will receive the EmailCampaign object as an argument
 CTCT_REPLY_TO_EMAIL = "YOUR_REPLY_TO_ADDRESS"
 CTCT_PHYSICAL_ADDRESS = {
-  'address_line1': '1060 W Addison St',
-  'address_line2': '',
-  'address_optional': '',
-  'city': 'Chicago',
-  'country_code': 'US',
-  'country_name': 'United States',
-  'organization_name': 'Wrigley Field',
-  'postal_code': '60613',
-  'state_code': 'IL',
+  "address_line1": "1060 W Addison St",
+  "address_line2": "",
+  "address_optional": "",
+  "city": "Chicago",
+  "country_code": "US",
+  "country_name": "United States",
+  "organization_name": "Wrigley Field",
+  "postal_code": "60613",
+  "state_code": "IL",
 }
 CTCT_PREVIEW_RECIPIENTS = (
-  ('First Recipient', 'first@recipient.com'),
-  ('Second Recipient', 'second@recipient.com'),
+  ("First Recipient", "first@recipient.com"),
+  ("Second Recipient", "second@recipient.com"),
 )
+CTCT_PREVIEW_RECIPIENTS_CALLABLE = "myproject.myapp.ctct.get_preview_recipients"
 CTCT_PREVIEW_MESSAGE = "This is an EmailCampaign preview."
+CTCT_PREVIEW_MESSAGE_CALLABLE = "myproject.myapp.ctct.get_preview_message"
 
 # Optional functionality settings and their default settings
-CTCT_USE_ADMIN = False       # Add django-ctct models to admin
-CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct account
+CTCT_USE_ADMIN = False  # Add django-ctct models to admin
+CTCT_SYNC_ADMIN = False  # Django admin CRUD operations will sync with ctct account
 ```
 
 **Important:** Store your API credentials securely. Avoid committing them directly to your version control repository.
@@ -99,7 +101,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 > ./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:
 
@@ -132,16 +134,22 @@ To install dev dependencies:
 ```bash
 > git clone git@github.com:geoffrey-eisenbarth/django-ctct.git
 > cd django-ctct
-> python -m pip install --upgrade pip
-> pip intall poetry
-> poetry install --with dev
+> curl -LsSf https://astral.sh/uv/install.sh | sh
+> uv sync --group dev
 ```
 
 To run tests:
 
 ```bash
-> poetry run coverage run tests/project/manage.py test
-> poetry run coverage report
+> uv run coverage run tests/project/manage.py test
+> uv run coverage report
+```
+
+To lint and format:
+
+```bash
+> uv run ruff check .
+> uv run ruff format .
 ```
 
 
@@ -149,9 +157,6 @@ To run tests:
 
 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.