django-pfx 1.7.6.dev13__tar.gz → 1.7.6.dev17__tar.gz

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev13
+Version: 1.7.6.dev17
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev13
+Version: 1.7.6.dev17
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/django_pfx.egg-info/SOURCES.txt

@@ -44,6 +44,8 @@ pfx/emails/tasks.py
 pfx/emails/urls.py
 pfx/emails/email_backend/__init__.py
 pfx/emails/email_backend/q_mailjet_email_backend.py
+pfx/emails/locale/fr/LC_MESSAGES/django.mo
+pfx/emails/locale/fr/LC_MESSAGES/django.po
 pfx/emails/mailjet/__init__.py
 pfx/emails/mailjet/mailjet.py
 pfx/emails/mailjet/message_result.py
@@ -51,6 +53,7 @@ pfx/emails/migrations/0001_initial.py
 pfx/emails/migrations/0002_alter_email_headers.py
 pfx/emails/migrations/0003_alter_email_options.py
 pfx/emails/migrations/0004_alter_email_mail_from.py
+pfx/emails/migrations/0005_lowercase_verbose_names.py
 pfx/emails/migrations/__init__.py
 pfx/emails/models/__init__.py
 pfx/emails/models/email.py
@@ -108,6 +111,7 @@ pfx/pfxcore/migrations/0004_alter_loginban_failed_counter_and_more.py
 pfx/pfxcore/migrations/0005_mfadevice_mfadevice_mfa_device_unique_backend.py
 pfx/pfxcore/migrations/0006_alter_pfxuser_managers.py
 pfx/pfxcore/migrations/0007_alter_pfxuser_options.py
+pfx/pfxcore/migrations/0008_lowercase_verbose_names.py
 pfx/pfxcore/migrations/__init__.py
 pfx/pfxcore/migrations/operations/__init__.py
 pfx/pfxcore/migrations/operations/permissions.py
@@ -179,6 +183,7 @@ pfx/userjobs/migrations/0002_alter_userjob_options_alter_userjob_auto_queued_and
 pfx/userjobs/migrations/0003_clean_scheduled_tasks.py
 pfx/userjobs/migrations/0004_userjob_summary_url.py
 pfx/userjobs/migrations/0005_swappable_user_job.py
+pfx/userjobs/migrations/0006_lowercase_verbose_names.py
 pfx/userjobs/migrations/__init__.py
 pfx/userjobs/models/__init__.py
 pfx/userjobs/models/user_job.py
@@ -223,6 +228,7 @@ tests/tests/test_emails_send_email_message.py
 tests/tests/test_fields_choices.py
 tests/tests/test_fields_date.py
 tests/tests/test_fields_decimal.py
+tests/tests/test_fields_help_text.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_one2many.py
 tests/tests/test_fields_rich_text.py
@@ -247,6 +253,7 @@ tests/tests/test_user_job_messages.py
 tests/tests/test_user_job_model.py
 tests/tests/test_user_queryset.py
 tests/tests/test_user_websocket.py
+tests/tests/test_verbose_names.py
 tests/tests/test_version_check.py
 tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py
@@ -285,6 +292,7 @@ tests_custom_user_job/providers.py
 tests_custom_user_job/scope.py
 tests_custom_user_job/urls.py
 tests_custom_user_job/migrations/0001_initial.py
+tests_custom_user_job/migrations/0002_lowercase_verbose_names.py
 tests_custom_user_job/migrations/__init__.py
 tests_custom_user_job/settings/__init__.py
 tests_custom_user_job/settings/ci.py

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/django_pfx.egg-info/scm_file_list.json

@@ -31,6 +31,7 @@
     "pfx/emails/email_backend/__init__.py",
     "pfx/emails/email_backend/q_mailjet_email_backend.py",
     "pfx/emails/exceptions.py",
+    "pfx/emails/locale/fr/LC_MESSAGES/django.po",
     "pfx/emails/mailjet/__init__.py",
     "pfx/emails/mailjet/mailjet.py",
     "pfx/emails/mailjet/message_result.py",
@@ -38,6 +39,7 @@
     "pfx/emails/migrations/0002_alter_email_headers.py",
     "pfx/emails/migrations/0003_alter_email_options.py",
     "pfx/emails/migrations/0004_alter_email_mail_from.py",
+    "pfx/emails/migrations/0005_lowercase_verbose_names.py",
     "pfx/emails/migrations/__init__.py",
     "pfx/emails/models/__init__.py",
     "pfx/emails/models/email.py",
@@ -92,6 +94,7 @@
     "pfx/pfxcore/migrations/0005_mfadevice_mfadevice_mfa_device_unique_backend.py",
     "pfx/pfxcore/migrations/0006_alter_pfxuser_managers.py",
     "pfx/pfxcore/migrations/0007_alter_pfxuser_options.py",
+    "pfx/pfxcore/migrations/0008_lowercase_verbose_names.py",
     "pfx/pfxcore/migrations/__init__.py",
     "pfx/pfxcore/migrations/operations/__init__.py",
     "pfx/pfxcore/migrations/operations/permissions.py",
@@ -165,6 +168,7 @@
     "pfx/userjobs/migrations/0003_clean_scheduled_tasks.py",
     "pfx/userjobs/migrations/0004_userjob_summary_url.py",
     "pfx/userjobs/migrations/0005_swappable_user_job.py",
+    "pfx/userjobs/migrations/0006_lowercase_verbose_names.py",
     "pfx/userjobs/migrations/__init__.py",
     "pfx/userjobs/models/__init__.py",
     "pfx/userjobs/models/user_job.py",
@@ -214,6 +218,7 @@
     "tests/tests/test_fields_choices.py",
     "tests/tests/test_fields_date.py",
     "tests/tests/test_fields_decimal.py",
+    "tests/tests/test_fields_help_text.py",
     "tests/tests/test_fields_minutes_duration.py",
     "tests/tests/test_fields_one2many.py",
     "tests/tests/test_fields_rich_text.py",
@@ -238,6 +243,7 @@
     "tests/tests/test_user_job_model.py",
     "tests/tests/test_user_queryset.py",
     "tests/tests/test_user_websocket.py",
+    "tests/tests/test_verbose_names.py",
     "tests/tests/test_version_check.py",
     "tests/tests/test_view_decorators.py",
     "tests/tests/test_view_fields.py",
@@ -274,6 +280,7 @@
     "tests_custom_user/views.py",
     "tests_custom_user_job/__init__.py",
     "tests_custom_user_job/migrations/0001_initial.py",
+    "tests_custom_user_job/migrations/0002_lowercase_verbose_names.py",
     "tests_custom_user_job/migrations/__init__.py",
     "tests_custom_user_job/models.py",
     "tests_custom_user_job/providers.py",

django_pfx-1.7.6.dev17/django_pfx.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.7.5",
+  "distance": 17,
+  "node": "g6910de203ed115d5c1a33a4a98e16967547933d6",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-29"
+}

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/doc/source/pfx_views.md

@@ -272,6 +272,10 @@ field = [VF('name')]
 ```
 You can specify following optional attributes:
 * `verbose_name`
+* `help_text`: defaults to the model field `help_text` (or the `help_text`
+  argument of `@rest_property`), use an empty string to disable it.
+  It is returned by the `/meta` services and used as the field `description`
+  in the generated OpenAPI documentation.
 * `field_type`
 * `alias`
 * `readonly`
@@ -286,7 +290,7 @@ Refer to method documentation for details.
 ### Meta
 
 The `ModelResponseMixin` (included in every mixin with a service whose response is a simple object),
-exposes a `/meta` service to identify fields (and their characteristics: type, required, readonly, ...),
+exposes a `/meta` service to identify fields (and their characteristics: type, required, readonly, help_text, ...),
 to enable automatic generation of forms.
 
 See the generated API documentation for more details.

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/make_messages

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
 (cd pfx/pfxcore && django-admin makemessages -a)
 (cd pfx/userjobs && django-admin makemessages -a)
+(cd pfx/emails && django-admin makemessages -a)
 (cd tests && django-admin makemessages -a)

django_pfx-1.7.6.dev17/pfx/emails/locale/fr/LC_MESSAGES/django.po

@@ -0,0 +1,163 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2026-09-28 18:07+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#: models/email.py:62
+msgid "To send"
+msgstr "À envoyer"
+
+#: models/email.py:63
+msgid "Sending"
+msgstr "En cours d’envoi"
+
+#: models/email.py:64
+msgid "Sent"
+msgstr "Envoyé"
+
+#: models/email.py:65
+msgid "Delivered"
+msgstr "Délivré"
+
+#: models/email.py:66
+msgid "Delivery Error"
+msgstr "Erreur de délivrance"
+
+#: models/email.py:67
+msgid "Error"
+msgstr "Erreur"
+
+#: models/email.py:68
+msgid "Error Retry"
+msgstr "Erreur, nouvel essai"
+
+#: models/email.py:69
+msgid "Blocked"
+msgstr "Bloqué"
+
+#: models/email.py:72
+msgid "send date"
+msgstr "date d’envoi"
+
+#: models/email.py:74
+msgid "mail from"
+msgstr "expéditeur"
+
+#: models/email.py:75
+msgid "mail to"
+msgstr "destinataires"
+
+#: models/email.py:76
+msgid "mail cc"
+msgstr "copie"
+
+#: models/email.py:77
+msgid "mail bcc"
+msgstr "copie cachée"
+
+#: models/email.py:78
+msgid "subject"
+msgstr "objet"
+
+#: models/email.py:79
+msgid "text part"
+msgstr "partie texte"
+
+#: models/email.py:80
+msgid "HTML part"
+msgstr "partie HTML"
+
+#: models/email.py:81
+msgid "headers"
+msgstr "en-têtes"
+
+#: models/email.py:84
+msgid "status"
+msgstr "statut"
+
+#: models/email.py:87
+msgid "HTTP status code"
+msgstr "code de statut HTTP"
+
+#: models/email.py:88
+msgid "errors"
+msgstr "erreurs"
+
+#: models/email.py:90
+msgid "send mode"
+msgstr "mode d’envoi"
+
+#: models/email.py:91
+msgid "Manual"
+msgstr "Manuel"
+
+#: models/email.py:92
+msgid "Auto"
+msgstr "Automatique"
+
+#: models/email.py:93
+msgid "Auto Async"
+msgstr "Automatique asynchrone"
+
+#: models/email.py:94
+msgid "delete delivered"
+msgstr "supprimer après délivrance"
+
+#: models/email.py:96
+msgid "send task ID"
+msgstr "ID de la tâche d’envoi"
+
+#: models/email.py:97
+msgid "retry count"
+msgstr "nombre de tentatives"
+
+#: models/email.py:101
+msgid "Email"
+msgstr "Email"
+
+#: models/email.py:102
+msgid "Emails"
+msgstr "Emails"
+
+#: models/email.py:114
+msgid "to"
+msgstr "à"
+
+#: models/email.py:120
+msgid "cc"
+msgstr "cc"
+
+#: models/email.py:126
+msgid "bcc"
+msgstr "cci"
+
+#: models/email.py:182 models/email.py:189
+msgid "Cannot be empty."
+msgstr "Ne peut pas être vide."
+
+#: models/email.py:184 models/email.py:191 models/email.py:198
+#: models/email.py:205
+msgid "Invalid format."
+msgstr "Format invalide."
+
+#: models/email.py:212
+msgid "Email must contain a text_part or an html_part."
+msgstr "L’email doit contenir une partie texte ou une partie HTML."
+
+#: models/email.py:289
+msgid "Error while updating the message"
+msgstr "Erreur lors de la mise à jour du message"

django_pfx-1.7.6.dev17/pfx/emails/migrations/0005_lowercase_verbose_names.py

@@ -0,0 +1,97 @@
+# Generated by Django 5.2.16 on 2026-09-28 15:34
+# flake8: noqa
+
+from django.db import migrations, models
+
+import pfx.emails.shortcuts
+import pfx.pfxcore.models.not_null_fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('emails', '0004_alter_email_mail_from'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='email',
+            name='delete_delivered',
+            field=models.BooleanField(default=True, verbose_name='delete delivered'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='errors',
+            field=models.JSONField(blank=True, null=True, verbose_name='errors'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='headers',
+            field=models.JSONField(blank=True, default=dict, verbose_name='headers'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='html_part',
+            field=pfx.pfxcore.models.not_null_fields.NotNullTextField(blank=True, verbose_name='HTML part'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='mail_bcc',
+            field=models.JSONField(blank=True, default=list, verbose_name='mail bcc'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='mail_cc',
+            field=models.JSONField(blank=True, default=list, verbose_name='mail cc'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='mail_from',
+            field=models.JSONField(default=pfx.emails.shortcuts.default_mail_from_json, verbose_name='mail from'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='mail_to',
+            field=models.JSONField(default=list, verbose_name='mail to'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='retry_count',
+            field=models.IntegerField(default=0, verbose_name='retry count'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='send_date',
+            field=models.DateTimeField(auto_now_add=True, null=True, verbose_name='send date'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='send_mode',
+            field=models.CharField(choices=[('manual', 'Manual'), ('auto', 'Auto'), ('auto_async', 'Auto Async')], db_index=True, default='auto_async', max_length=32, verbose_name='send mode'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='send_task_id',
+            field=models.CharField(blank=True, max_length=255, null=True, unique=True, verbose_name='send task ID'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='status',
+            field=models.CharField(choices=[('to_send', 'To send'), ('sending', 'Sending'), ('sent', 'Sent'), ('delivered', 'Delivered'), ('delivery_error', 'Delivery Error'), ('error', 'Error'), ('error_retry', 'Error Retry'), ('blocked', 'Blocked')], db_index=True, default='to_send', max_length=32, verbose_name='status'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='status_code',
+            field=models.IntegerField(blank=True, null=True, verbose_name='HTTP status code'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='subject',
+            field=models.CharField(max_length=255, verbose_name='subject'),
+        ),
+        migrations.AlterField(
+            model_name='email',
+            name='text_part',
+            field=pfx.pfxcore.models.not_null_fields.NotNullTextField(blank=True, verbose_name='text part'),
+        ),
+    ]

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/pfx/emails/models/email.py

@@ -69,32 +69,32 @@ class AbstractEmail(models.Model):
         ('blocked', _("Blocked"))]
 
     send_date = models.DateTimeField(
-        _('Send date'), blank=True, null=True, auto_now_add=True)
+        _("send date"), blank=True, null=True, auto_now_add=True)
     mail_from = models.JSONField(
-        _("Mail From"), default=default_mail_from_json)
-    mail_to = models.JSONField(_("Mail To"), default=list)
-    mail_cc = models.JSONField(_("Mail Cc"), blank=True, default=list)
-    mail_bcc = models.JSONField(_("Mail Bcc"), blank=True, default=list)
-    subject = models.CharField(_("Subject"), max_length=255)
-    text_part = NotNullTextField(_("Text Part"), blank=True)
-    html_part = NotNullTextField(_("HTML Part"), blank=True)
-    headers = models.JSONField(_("Headers"), default=dict, blank=True)
+        _("mail from"), default=default_mail_from_json)
+    mail_to = models.JSONField(_("mail to"), default=list)
+    mail_cc = models.JSONField(_("mail cc"), blank=True, default=list)
+    mail_bcc = models.JSONField(_("mail bcc"), blank=True, default=list)
+    subject = models.CharField(_("subject"), max_length=255)
+    text_part = NotNullTextField(_("text part"), blank=True)
+    html_part = NotNullTextField(_("HTML part"), blank=True)
+    headers = models.JSONField(_("headers"), default=dict, blank=True)
     attachments = models.JSONField('Attachments', blank=True, default=list)
     status = models.CharField(
-        _("Status"), max_length=32, db_index=True, choices=STATUS_LIST,
+        _("status"), max_length=32, db_index=True, choices=STATUS_LIST,
         default='to_send')
     status_code = models.IntegerField(
-        _("HTTP Status Code"), blank=True, null=True)
-    errors = models.JSONField(_("Errors"), blank=True, null=True)
+        _("HTTP status code"), blank=True, null=True)
+    errors = models.JSONField(_("errors"), blank=True, null=True)
     send_mode = models.CharField(
-        _("Send Mode"), max_length=32, db_index=True, choices=[
+        _("send mode"), max_length=32, db_index=True, choices=[
             ('manual', _("Manual")),
             ('auto', _("Auto")),
             ('auto_async', _("Auto Async"))], default='auto_async')
-    delete_delivered = models.BooleanField(_("Delete Delivered"), default=True)
+    delete_delivered = models.BooleanField(_("delete delivered"), default=True)
     send_task_id = models.CharField(
-        _("Send Task Id"), max_length=255, unique=True, blank=True, null=True)
-    retry_count = models.IntegerField(_("Retry count"), default=0)
+        _("send task ID"), max_length=255, unique=True, blank=True, null=True)
+    retry_count = models.IntegerField(_("retry count"), default=0)
 
     class Meta:
         db_table = "emails_email"
@@ -111,19 +111,19 @@ class AbstractEmail(models.Model):
     def _display_to(self):
         return format_json_mail_list(self.mail_to or [])
 
-    _display_to.short_description = _("To")
+    _display_to.short_description = _("to")
     display_to = property(_display_to)
 
     def _display_cc(self):
         return format_json_mail_list(self.mail_cc or [])
 
-    _display_cc.short_description = _("Cc")
+    _display_cc.short_description = _("cc")
     display_cc = property(_display_cc)
 
     def _display_bcc(self):
         return format_json_mail_list(self.mail_bcc or [])
 
-    _display_bcc.short_description = _("Bcc")
+    _display_bcc.short_description = _("bcc")
     display_bcc = property(_display_bcc)
 
     @property

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev17}/pfx/pfxcore/decorator/rest.py

@@ -54,9 +54,12 @@ def rest_api(
     return decorator
 
 
-def rest_property(string=None, type="CharField", field=None, order=None):
+def rest_property(
+        string=None, type="CharField", field=None, order=None,
+        help_text=None):
     def decorator(func):
         func.short_description = string
+        func.help_text = help_text
         func.field_type = type
         func.field = field
         func.order = order