django-dynamic-smtp 0.0.1__tar.gz

django_dynamic_smtp-0.0.1/.gitignore

@@ -0,0 +1,4 @@
+/venv/
+/build/
+/db.sqlite3
+__pycache__

django_dynamic_smtp-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.10
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

django_dynamic_smtp-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 João Seckler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_dynamic_smtp-0.0.1/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: django-dynamic-smtp
+Version: 0.0.1
+Summary: Configure email settings in the admin
+Project-URL: Homepage, https://gitlab.com/joaoseckler/django-dynamic-smtp
+Project-URL: Issues, https://gitlab.com/joaoseckler/django-dynamic-smtp/issues
+Author-email: João Seckler <jseckler@riseup.net>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# Django dynamic SMTP
+
+Configure email configuration in the admin.
+
+## Usage
+
+1. Install with `pip install django-dynamic-smtp`
+
+2. Add `dynamic_smtp` to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...,
+    "dynamic_smtp",
+]
+```
+
+3. Configure your email backend:
+
+```
+EMAIL_BACKEND = (
+    "django.core.mail.backends.console.EmailBackend"
+    if DEBUG
+    else "dynamic_smtp.email.DynamicSMPTEmailBackend"
+)
+```
+
+4. Migrate: `./manage.py migrate`
+5. Access you admin and configure your SMTP settings
+
+## Contributing
+
+All contributions are welcome! To setup you environment:
+
+1. `pip install -r dev.requirements.txt`
+2. `pre-commit install`

django_dynamic_smtp-0.0.1/README.md

@@ -0,0 +1,36 @@
+# Django dynamic SMTP
+
+Configure email configuration in the admin.
+
+## Usage
+
+1. Install with `pip install django-dynamic-smtp`
+
+2. Add `dynamic_smtp` to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    ...,
+    "dynamic_smtp",
+]
+```
+
+3. Configure your email backend:
+
+```
+EMAIL_BACKEND = (
+    "django.core.mail.backends.console.EmailBackend"
+    if DEBUG
+    else "dynamic_smtp.email.DynamicSMPTEmailBackend"
+)
+```
+
+4. Migrate: `./manage.py migrate`
+5. Access you admin and configure your SMTP settings
+
+## Contributing
+
+All contributions are welcome! To setup you environment:
+
+1. `pip install -r dev.requirements.txt`
+2. `pre-commit install`

django_dynamic_smtp-0.0.1/dev.requirements.txt

@@ -0,0 +1,4 @@
+django-stubs==5.1.3
+django-stubs-ext==5.1.3
+types-PyYAML==6.0.12.20241230
+typing_extensions==4.12.2

django_dynamic_smtp-0.0.1/dynamic_smtp/admin.py

@@ -0,0 +1,56 @@
+from smtplib import SMTPException
+
+from django.contrib import admin, messages
+from django.core import mail
+from django.core.mail.backends.console import EmailBackend as ConsoleEmailBackend
+from django.http import HttpRequest
+from django.utils.translation import gettext_lazy as _
+from django_object_actions import DjangoObjectActions, action
+from solo.admin import SingletonModelAdmin
+
+from .models import EmailConfiguration
+
+
+@admin.register(EmailConfiguration)
+class EmailConfigurationAdmin(DjangoObjectActions, SingletonModelAdmin):
+    change_actions = ["test_email"]
+
+    @action(
+        label=_("Test email"),
+        description=_(
+            "Send a test email from the account configured below to the "
+            "email registered as sender. Save before using."
+        ),
+    )
+    def test_email(self, request: HttpRequest, obj: EmailConfiguration):
+        host = request.get_host()
+        try:
+            with mail.get_connection() as connection:
+                if type(connection) is ConsoleEmailBackend:
+                    raise AssertionError(
+                        _("Using debug backend. Try using DEBUG=False in settings")
+                    )
+                __ = mail.send_mail(
+                    message=_(
+                        "This email has been sent to verify if the "
+                        "mailing system is well configured in the "
+                        "%(host)s's administration. It seems so!"
+                    )
+                    % {"host": host},
+                    from_email=obj.from_email,
+                    subject=_("[%(host)s] Email test") % {"host": host},
+                    recipient_list=[obj.from_email],
+                    fail_silently=False,
+                    connection=connection,
+                )
+        except (SMTPException, AssertionError) as e:
+            messages.error(
+                request,
+                _("Email not well configured: %s") % str(e),
+            )
+            return
+
+        messages.success(
+            request,
+            _("Email is well configured! :)"),
+        )

django_dynamic_smtp-0.0.1/dynamic_smtp/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class DynamicSmtpConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "dynamic_smtp"
+    verbose_name = _("Email configuration")

django_dynamic_smtp-0.0.1/dynamic_smtp/email.py

@@ -0,0 +1,65 @@
+from collections.abc import Sequence
+
+from bs4 import BeautifulSoup
+from django.core import mail
+from django.core.mail.backends.smtp import EmailBackend
+
+from .models import EmailConfiguration
+
+
+class DynamicSMPTEmailBackend(EmailBackend):
+    def __init__(
+        self,
+        host: str | None = None,
+        port: str | None = None,
+        username: str | None = None,
+        password: str | None = None,
+        use_tls: str | None = None,
+        fail_silently: bool = False,
+        use_ssl: str | None = None,
+        timeout: str | None = None,
+        ssl_keyfile: str | None = None,
+        ssl_certfile: str | None = None,
+        **kwargs: ...,
+    ):
+        conf = EmailConfiguration.get_solo()
+
+        super().__init__(
+            host=host or conf.host,
+            port=port or conf.port,
+            username=username or conf.username,
+            password=password or conf.password,
+            use_tls=use_tls or conf.use_tls,
+            fail_silently=fail_silently,
+            use_ssl=use_ssl or conf.use_ssl,
+            timeout=timeout or conf.timeout,
+            ssl_keyfile=ssl_keyfile,
+            ssl_certfile=ssl_certfile,
+            **kwargs,
+        )
+
+
+def html2text(html: str):
+    return BeautifulSoup(html, "lxml").get_text()
+
+
+def send_mail(
+    subject: str,
+    message: str,
+    recipients: Sequence[str] | str,
+):
+    mailconf = EmailConfiguration.get_solo()
+    recipient_list = (
+        recipients.split(",") if isinstance(recipients, str) else recipients
+    )
+
+    return mail.send_mail(
+        subject,
+        html2text(message),
+        recipient_list=recipient_list,
+        html_message=message,
+        fail_silently=False,
+        auth_user=mailconf.username,
+        auth_password=mailconf.password,
+        from_email=mailconf.from_email,
+    )

django_dynamic_smtp-0.0.1/dynamic_smtp/migrations/0001_initial.py

@@ -0,0 +1,99 @@
+# Generated by Django 5.1.7 on 2025-03-12 16:24
+
+import tinymce.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="EmailConfiguration",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "activated",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Só ative essa opção depois de testar as configurações de email no botão ao lado. Quando ativado, as notificações vão ser enviadas por email e será possível a usuários redefinir suas senhas.",
+                        verbose_name="Email está ativado?",
+                    ),
+                ),
+                (
+                    "host",
+                    models.CharField(
+                        default="smtp.gmail.com", max_length=128, verbose_name="Host"
+                    ),
+                ),
+                (
+                    "port",
+                    models.PositiveIntegerField(default=587, verbose_name="Porta"),
+                ),
+                (
+                    "username",
+                    models.CharField(
+                        default="example@gmail.com",
+                        max_length=128,
+                        verbose_name="Usuário",
+                    ),
+                ),
+                (
+                    "password",
+                    models.CharField(
+                        default="1234", max_length=128, verbose_name="Senha"
+                    ),
+                ),
+                ("use_tls", models.BooleanField(default=True, verbose_name="Usar TLS")),
+                (
+                    "use_ssl",
+                    models.BooleanField(default=False, verbose_name="Usar SSL"),
+                ),
+                (
+                    "timeout",
+                    models.IntegerField(
+                        blank=True, default=120, null=True, verbose_name="Timeout"
+                    ),
+                ),
+                (
+                    "from_name",
+                    models.CharField(
+                        blank=True,
+                        max_length=255,
+                        null=True,
+                        verbose_name="Nome do remetente",
+                    ),
+                ),
+                (
+                    "from_email",
+                    models.EmailField(
+                        default="admin@example.com",
+                        max_length=254,
+                        verbose_name="Email remetente",
+                    ),
+                ),
+                (
+                    "signature",
+                    tinymce.models.HTMLField(
+                        blank=True,
+                        help_text="Para usar essa assinatura em seus emails, utilize a variável <code>{{ signature }}</code>.",
+                        null=True,
+                        verbose_name="Assinatura dos emails",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Email configuration",
+            },
+        ),
+    ]

django_dynamic_smtp-0.0.1/dynamic_smtp/models.py

@@ -0,0 +1,81 @@
+from typing import override
+
+from django.db import models
+from django.utils.html import format_html
+from django.utils.translation import gettext_lazy as _
+from solo.models import SingletonModel
+from tinymce.models import HTMLField
+
+
+class EmailConfiguration(SingletonModel):
+    activated = models.BooleanField(
+        default=False,
+        verbose_name=_("Email está ativado?"),
+        help_text=_(
+            "Só ative essa opção depois de testar as configurações de "
+            + "email no botão ao lado. Quando ativado, as notificações vão "
+            + "ser enviadas por email e será possível a usuários "
+            + "redefinir suas senhas."
+        ),
+    )
+    host = models.CharField(
+        max_length=128,
+        verbose_name=_("Host"),
+        default="smtp.gmail.com",
+    )
+    port = models.PositiveIntegerField(
+        verbose_name=_("Porta"),
+        default=587,
+    )
+    username = models.CharField(
+        max_length=128,
+        verbose_name=_("Usuário"),
+        default="example@gmail.com",
+    )
+    password = models.CharField(
+        max_length=128,
+        verbose_name=_("Senha"),
+        default="1234",
+    )
+    use_tls = models.BooleanField(
+        default=True,
+        verbose_name=_("Usar TLS"),
+    )
+    use_ssl = models.BooleanField(
+        default=False,
+        verbose_name=_("Usar SSL"),
+    )
+    timeout = models.IntegerField(
+        blank=True,
+        null=True,
+        default=120,
+        verbose_name=_("Timeout"),
+    )
+    from_name = models.CharField(
+        max_length=255,
+        verbose_name=_("Nome do remetente"),
+        null=True,
+        blank=True,
+    )
+    from_email = models.EmailField(
+        verbose_name=_("Email remetente"),
+        default="admin@example.com",
+    )
+    signature = HTMLField(
+        blank=True,
+        null=True,
+        verbose_name=_("Assinatura dos emails"),
+        help_text=format_html(
+            "{}<code>{}</code>{}",
+            _("Para usar essa assinatura em seus emails, utilize a variável "),
+            "{{ signature }}",
+            ".",
+        ),
+    )
+
+    @override
+    def __str__(self):
+        return str(self._meta.verbose_name)
+
+    class Meta:
+        verbose_name = _("Email configuration")

django_dynamic_smtp-0.0.1/makemigrations.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+
+from django import setup
+from django.conf import settings
+from django.core.management import call_command
+
+BASE_DIR = Path(__file__).resolve().parent
+
+
+def boot_django():
+    settings.configure(
+        BASE_DIR=BASE_DIR,
+        DEBUG=True,
+        DATABASES={
+            "default": {
+                "ENGINE": "django.db.backends.sqlite3",
+                "NAME": BASE_DIR / "db.sqlite3",
+            }
+        },
+        INSTALLED_APPS=(
+            "django.contrib.auth",
+            "django.contrib.contenttypes",
+            "dynamic_smtp",
+        ),
+    )
+
+    setup()
+
+
+boot_django()
+ret = call_command("makemigrations", "dynamic_smtp")
+print(ret)

django_dynamic_smtp-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "django-dynamic-smtp"
+version = "0.0.1"
+authors = [
+  { name="João Seckler", email="jseckler@riseup.net" },
+]
+description = "Configure email settings in the admin"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://gitlab.com/joaoseckler/django-dynamic-smtp"
+Issues = "https://gitlab.com/joaoseckler/django-dynamic-smtp/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["dynamic_smtp"]

django_dynamic_smtp-0.0.1/pyrightconfig.json

@@ -0,0 +1,10 @@
+{
+  "include": [
+    "./dynamic_smtp/"
+  ],
+  "reportAny": false,
+  "reportImplicitStringConcatenation": false,
+  "reportUnannotatedClassAttribute": false,
+  "reportIgnoreCommentWithoutRule": false,
+  "enableTypeIgnoreComments": true
+}

django_dynamic_smtp-0.0.1/requirements.txt

@@ -0,0 +1,9 @@
+asgiref==3.8.1
+beautifulsoup4==4.13.3
+Django==5.1.7
+django-object-actions==4.3.0
+django-solo==2.4.0
+django-tinymce==4.1.0
+lxml==5.3.1
+soupsieve==2.6
+sqlparse==0.5.3