Rename plain.mail to plain.email

Author: davegaeddert

README.md

@@ -24,7 +24,7 @@ With the official Plain ecosystem packages you can:
 - Use a built-in [user authentication](https://plainframework.com/docs/plain-auth/) system
 - [Lint and format code](https://plainframework.com/docs/plain-code/)
 - Run a [database-backed cache](https://plainframework.com/docs/plain-cache/)
-- [Send emails](https://plainframework.com/docs/plain-mail/)
+- [Send emails](https://plainframework.com/docs/plain-email/)
 - Streamline [local development](https://plainframework.com/docs/plain-dev/)
 - Manage [feature flags](https://plainframework.com/docs/plain-flags/)
 - Integrate [HTMX](https://plainframework.com/docs/plain-htmx/)

plain-mail/LICENSE renamed to plain-email/LICENSE

@@ -1,15 +1,15 @@
-# plain.mail
+# plain.email
 
 Everything you need to send email.
 
 ## Installation
 
-Add `plain.mail` to your `INSTALLED_APPS`:
+Add `plain.email` to your `INSTALLED_APPS`:
 
 ```python
 # settings.py
 INSTALLED_APPS = [
     # ...
-    'plain.mail',
+    'plain.email',
 ]
 ```

plain-mail/README.md renamed to plain-email/README.md

@@ -1,4 +1,4 @@
-# The email backend to use. For possible shortcuts see plain.mail.
+# The email backend to use. For possible shortcuts see plain.email.
 # The default is to use the SMTP backend.
 # Third-party backends can be specified by providing a Python path
 # to a module that defines an EmailBackend class.

plain-mail/plain/mail/README.md renamed to plain-email/plain/email/README.md

@@ -1,5 +1,5 @@
 [project]
-name = "plain.mail"
+name = "plain.email"
 version = "0.7.0"
 description = "Email sending for Plain."
 authors = [{name = "Dave Gaeddert", email = "[email protected]"}]

plain-mail/plain/mail/__init__.py renamed to plain-email/plain/email/__init__.py

@@ -1,6 +1,6 @@
 from plain import forms
 from plain.auth import get_user_model
-from plain.mail import TemplateEmail
+from plain.email import TemplateEmail
 
 from .links import generate_link_url
 

plain-mail/plain/mail/backends/__init__.py renamed to plain-email/plain/email/backends/__init__.py

@@ -7,7 +7,7 @@ readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
     "plain<1.0.0",
-    "plain-mail<1.0.0",
+    "plain-email<1.0.0",
 ]
 
 [tool.hatch.build.targets.wheel]

plain-mail/plain/mail/backends/base.py renamed to plain-email/plain/email/backends/base.py

@@ -19,7 +19,7 @@ urlpatterns = [
 
 This sets up a basic login view where users can authenticate using their username and password.
 
-For password resets to work, you also need to install [plain.mail](/plain-mail/README.md).
+For password resets to work, you also need to install [plain.email](/plain-email/README.md).
 
 ## FAQs
 

plain-mail/plain/mail/backends/console.py renamed to plain-email/plain/email/backends/console.py

@@ -21,7 +21,7 @@ def send_mail(
         from_email,
         to_email,
     ):
-        from plain.mail import TemplateEmail
+        from plain.email import TemplateEmail
 
         email = TemplateEmail(
             template=template_name,

plain-mail/plain/mail/backends/filebased.py renamed to plain-email/plain/email/backends/filebased.py

@@ -1,5 +1,5 @@
 from plain.auth import get_user_model
-from plain.mail import TemplateEmail
+from plain.email import TemplateEmail
 from plain.models.forms import ModelForm
 from plain.runtime import settings
 

plain-mail/plain/mail/backends/smtp.py renamed to plain-email/plain/email/backends/smtp.py

@@ -4,7 +4,7 @@ Process background jobs with a database-driven worker.
 
 ```python
 from plain.worker import Job
-from plain.mail import send_mail
+from plain.email import send_mail
 
 # Create a new job class
 class WelcomeUserJob(Job):

plain-mail/plain/mail/default_settings.py renamed to plain-email/plain/email/default_settings.py

@@ -29,7 +29,7 @@ The `plain` package includes everything you need to start handling web requests
 
 - [plain.models](/plain-models/README.md) - Define and interact with your database models.
 - [plain.cache](/plain-cache/README.md) - A database-driven general purpose cache.
-- [plain.mail](/plain-mail/README.md) - Send emails with SMTP or custom backends.
+- [plain.email](/plain-email/README.md) - Send emails with SMTP or custom backends.
 - [plain.sessions](/plain-sessions/README.md) - User sessions and cookies.
 - [plain.worker](/plain-worker/README.md) - Backgrounb jobs stored in the database.
 - [plain.api](/plain-api/README.md) - Build APIs with Plain views.

plain-mail/plain/mail/message.py renamed to plain-email/plain/email/message.py

@@ -17,7 +17,7 @@ requires-python = ">=3.11"
 "plain-htmx" = { workspace = true }
 "plain-importmap" = { workspace = true }
 "plain-loginlink" = { workspace = true }
-"plain-mail" = { workspace = true }
+"plain-email" = { workspace = true }
 "plain-models" = { workspace = true }
 "plain-oauth" = { workspace = true }
 "plain-pages" = { workspace = true }
@@ -47,7 +47,7 @@ members = [
     "plain-htmx",
     "plain-importmap",
     "plain-loginlink",
-    "plain-mail",
+    "plain-email",
     "plain-models",
     "plain-oauth",
     "plain-pages",