django-solomon 0.1.3__tar.gz → 0.2.0__tar.gz

django_solomon-0.2.0/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to django-solomon will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-04-19
+
+### Added
+
+- Comprehensive guides for usage and contribution
+- Parallel test execution with pytest-xdist
+- Link to official documentation in README
+- New badges to README
+- Initial changelog structure
+
+### Changed
+
+- Improved documentation organization
+
+## [0.1.3] - 2025-04-19
+
+### Added
+
+- Initial public release of django-solomon
+- Passwordless authentication using magic links sent via email
+- Configurable link expiration time (default: 300 seconds)
+- Blacklist functionality to block specific email addresses
+- Support for auto-creating users when they request a magic link
+- Customizable templates for emails and pages
+- MJML support for HTML emails
+- Compatible with Django's authentication system
+- Support for Django 4.2, 5.0, 5.1, and 5.2
+- Support for Python 3.10, 3.11, 3.12, and 3.13
+- Comprehensive test suite with high code coverage
+- Full documentation
+
+### Security
+
+- One-time use magic links
+- Option to allow only one active magic link per user
+- Configurable permissions for admin and staff users

{django_solomon-0.1.3 → django_solomon-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-solomon
-Version: 0.1.3
+Version: 0.2.0
 Summary: A Django app for passwordless authentication using magic links.
 Project-URL: Home, https://django-solomon.rtfd.io/
 Project-URL: Documentation, https://django-solomon.rtfd.io/
@@ -55,6 +55,10 @@ Description-Content-Type: text/markdown
 [![Python versions](https://img.shields.io/pypi/pyversions/django-solomon.svg)](https://pypi.org/project/django-solomon/)
 [![Django versions](https://img.shields.io/pypi/djversions/django-solomon.svg)](https://pypi.org/project/django-solomon/)
 [![Documentation Status](https://readthedocs.org/projects/django-solomon/badge/?version=latest)](https://django-solomon.rtfd.io/en/latest/?badge=latest)
+[![Downloads](https://static.pepy.tech/badge/django-solomon)](https://pepy.tech/project/django-solomon)
+[![Downloads / Month](https://pepy.tech/badge/django-solomon/month)](https://pepy.tech/project/django-solomon)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 
 A Django app for passwordless authentication using magic links.
 
@@ -138,8 +142,8 @@ django-solomon provides several settings that you can customize in your Django s
 | `SOLOMON_LOGIN_REDIRECT_URL`          | `settings.LOGIN_REDIRECT_URL`                   | The URL to redirect to after successful authentication                                 |
 | `SOLOMON_ALLOW_ADMIN_LOGIN`           | `True`                                          | If enabled, allows superusers to log in using magic links                              |
 | `SOLOMON_ALLOW_STAFF_LOGIN`           | `True`                                          | If enabled, allows staff users to log in using magic links                             |
-| `SOLOMON_MAIL_TEXT_TEMPLATE`         | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
-| `SOLOMON_MAIL_MJML_TEMPLATE`         | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
+| `SOLOMON_MAIL_TEXT_TEMPLATE`          | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
+| `SOLOMON_MAIL_MJML_TEMPLATE`          | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
 | `SOLOMON_LOGIN_FORM_TEMPLATE`         | `"django_solomon/base/login_form.html"`         | The template to use for the login form page                                            |
 | `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE` | `"django_solomon/base/invalid_magic_link.html"` | The template to use for the invalid magic link page                                    |
 | `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`    | `"django_solomon/base/magic_link_sent.html"`    | The template to use for the magic link sent confirmation page                          |
@@ -189,9 +193,13 @@ if user:
     login(request, user)
 ```
 
+## Documentation
+
+For more detailed information, tutorials, and advanced usage examples, please visit the [official documentation](https://django-solomon.rtfd.io/).
+
 ## License
 
-This software is licensed under [MIT license](./LICENSE).
+This software is licensed under [MIT license](https://codeberg.org/oliverandrich/django-solomon/src/branch/main/LICENSE).
 
 ## Contributing
 

{django_solomon-0.1.3 → django_solomon-0.2.0}/README.md

@@ -4,6 +4,10 @@
 [![Python versions](https://img.shields.io/pypi/pyversions/django-solomon.svg)](https://pypi.org/project/django-solomon/)
 [![Django versions](https://img.shields.io/pypi/djversions/django-solomon.svg)](https://pypi.org/project/django-solomon/)
 [![Documentation Status](https://readthedocs.org/projects/django-solomon/badge/?version=latest)](https://django-solomon.rtfd.io/en/latest/?badge=latest)
+[![Downloads](https://static.pepy.tech/badge/django-solomon)](https://pepy.tech/project/django-solomon)
+[![Downloads / Month](https://pepy.tech/badge/django-solomon/month)](https://pepy.tech/project/django-solomon)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 
 A Django app for passwordless authentication using magic links.
 
@@ -87,8 +91,8 @@ django-solomon provides several settings that you can customize in your Django s
 | `SOLOMON_LOGIN_REDIRECT_URL`          | `settings.LOGIN_REDIRECT_URL`                   | The URL to redirect to after successful authentication                                 |
 | `SOLOMON_ALLOW_ADMIN_LOGIN`           | `True`                                          | If enabled, allows superusers to log in using magic links                              |
 | `SOLOMON_ALLOW_STAFF_LOGIN`           | `True`                                          | If enabled, allows staff users to log in using magic links                             |
-| `SOLOMON_MAIL_TEXT_TEMPLATE`         | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
-| `SOLOMON_MAIL_MJML_TEMPLATE`         | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
+| `SOLOMON_MAIL_TEXT_TEMPLATE`          | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
+| `SOLOMON_MAIL_MJML_TEMPLATE`          | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
 | `SOLOMON_LOGIN_FORM_TEMPLATE`         | `"django_solomon/base/login_form.html"`         | The template to use for the login form page                                            |
 | `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE` | `"django_solomon/base/invalid_magic_link.html"` | The template to use for the invalid magic link page                                    |
 | `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`    | `"django_solomon/base/magic_link_sent.html"`    | The template to use for the magic link sent confirmation page                          |
@@ -138,9 +142,13 @@ if user:
     login(request, user)
 ```
 
+## Documentation
+
+For more detailed information, tutorials, and advanced usage examples, please visit the [official documentation](https://django-solomon.rtfd.io/).
+
 ## License
 
-This software is licensed under [MIT license](./LICENSE).
+This software is licensed under [MIT license](https://codeberg.org/oliverandrich/django-solomon/src/branch/main/LICENSE).
 
 ## Contributing
 

django_solomon-0.2.0/docs/contributing.md

@@ -0,0 +1,138 @@
+---
+hide:
+  - navigation
+---
+
+# Contributing to django-solomon
+
+Thank you for your interest in contributing to django-solomon! This guide will help you get started with the development process.
+
+## Development Environment Setup
+
+### Prerequisites
+
+Before setting up the development environment, ensure you have:
+
+- Python 3.10 or higher
+- Git
+- [uv](https://github.com/astral-sh/uv) for dependency management
+- [just](https://github.com/casey/just) for running commands
+
+### Setting Up the Development Environment
+
+1. Clone the repository:
+
+```bash
+git clone https://codeberg.org/oliverandrich/django-solomon.git
+cd django-solomon
+```
+
+2. Set up the development environment using the bootstrap command:
+
+```bash
+just bootstrap
+```
+
+This command will:
+- Initialize a git repository
+- Install all dependencies
+- Set up pre-commit hooks
+
+If you already have a cloned repository, you can install dependencies with:
+
+```bash
+just upgrade
+```
+
+## Development Workflow
+
+### Running Tests
+
+To run the test suite with coverage reporting:
+
+```bash
+just test
+```
+
+To run the full test suite across all supported Python and Django versions:
+
+```bash
+just test-all
+```
+
+### Linting and Code Quality
+
+The project uses Ruff for linting and formatting. To run the linters:
+
+```bash
+just lint
+```
+
+This will run all pre-commit hooks, including Ruff linting and formatting.
+
+### Documentation
+
+To serve the documentation locally:
+
+```bash
+just serve-docs
+```
+
+This will start a local server at http://127.0.0.1:8000/ where you can preview the documentation.
+
+## Coding Standards
+
+### Python Style Guide
+
+The project follows the PEP 8 style guide with some modifications:
+
+- Maximum line length is 120 characters
+- Uses double quotes for strings
+- Does NOT use relative imports for internal modules
+
+Ruff is configured to enforce these standards. The configuration can be found in `pyproject.toml`.
+
+### Type Annotations
+
+The project uses type annotations and mypy for type checking. Please add type annotations to all new code.
+
+### Testing
+
+All new features and bug fixes should include tests. The project uses pytest for testing.
+
+- Place tests in the `tests/` directory
+- Ensure tests are isolated and don't depend on external services
+- Aim for high test coverage
+
+## Pull Request Process
+
+1. Fork the repository on [Codeberg](https://codeberg.org/oliverandrich/django-solomon)
+2. Create a new branch for your feature or bug fix
+3. Make your changes, following the coding standards
+4. Add tests for your changes
+5. Run the test suite to ensure all tests pass
+6. Update the documentation if necessary
+7. Submit a pull request to the main repository
+
+### Pull Request Guidelines
+
+- Keep pull requests focused on a single feature or bug fix
+- Include a clear description of the changes
+- Reference any related issues
+- Ensure all tests pass and code quality checks succeed
+- Update the CHANGELOG.md file if your changes are user-facing
+
+## Release Process
+
+The project follows [Semantic Versioning](https://semver.org/). The release process is handled by the maintainers.
+
+## Getting Help
+
+If you have questions or need help with the development process, you can:
+
+- Open an issue on [Codeberg](https://codeberg.org/oliverandrich/django-solomon/issues)
+- Contact the maintainers directly
+
+## Code of Conduct
+
+Please be respectful and considerate of others when contributing to the project. We aim to foster an inclusive and welcoming community.

django_solomon-0.2.0/docs/installation.md

@@ -0,0 +1,174 @@
+---
+hide:
+  - navigation
+---
+
+# Installation and Setup
+
+This guide will walk you through the process of installing and setting up django-solomon in your Django project.
+
+## Prerequisites
+
+Before installing django-solomon, ensure you have:
+
+- Python 3.10 or higher
+- Django 4.2 or higher
+- A working email configuration for sending magic links
+
+## Installation Methods
+
+### Using pip (Recommended)
+
+The simplest way to install django-solomon is using pip:
+
+```bash
+pip install django-solomon
+```
+
+### Using a Virtual Environment
+
+It's recommended to install django-solomon in a virtual environment:
+
+```bash
+# Create a virtual environment
+python -m venv venv
+
+# Activate the virtual environment
+# On Windows
+venv\Scripts\activate
+# On macOS/Linux
+source venv/bin/activate
+
+# Install django-solomon
+pip install django-solomon
+```
+
+### From Source
+
+You can also install django-solomon directly from the source code:
+
+```bash
+git clone https://codeberg.org/oliverandrich/django-solomon.git
+cd django-solomon
+pip install -e .
+```
+
+## Configuration Steps
+
+After installing django-solomon, you need to configure your Django project to use it:
+
+### 1. Add to INSTALLED_APPS
+
+Add `django_solomon` to your `INSTALLED_APPS` in your Django settings:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'django_solomon',
+    # ...
+]
+```
+
+### 2. Configure Authentication Backend
+
+Add the authentication backend to your settings:
+
+```python
+AUTHENTICATION_BACKENDS = [
+    'django_solomon.backends.MagicLinkBackend',
+    'django.contrib.auth.backends.ModelBackend',  # Keep the default backend
+]
+```
+
+### 3. Include URLs
+
+Include the django-solomon URLs in your project's `urls.py`:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    # ...
+    path('auth/', include('django_solomon.urls')),
+    # ...
+]
+```
+
+### 4. Set Login URL
+
+Set the login URL in your settings to use django-solomon's login view:
+
+```python
+LOGIN_URL = 'django_solomon:login'
+```
+
+This ensures that when users need to authenticate, they'll be redirected to the magic link login page.
+
+### 5. Configure Email Settings
+
+Configure your email settings to ensure magic link emails can be sent:
+
+```python
+EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+EMAIL_HOST = 'smtp.example.com'
+EMAIL_PORT = 587
+EMAIL_USE_TLS = True
+EMAIL_HOST_USER = 'your-email@example.com'
+EMAIL_HOST_PASSWORD = 'your-password'
+DEFAULT_FROM_EMAIL = 'your-email@example.com'
+```
+
+For development, you can use Django's console email backend to display emails in the console:
+
+```python
+EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+```
+
+## Customizing Settings
+
+django-solomon provides several settings that you can customize in your Django settings file. For a comprehensive list of all available settings and their detailed descriptions, please refer to the [Settings documentation](settings.md).
+
+## Verifying Installation
+
+To verify that django-solomon is correctly installed and configured:
+
+1. Start your Django development server:
+   ```bash
+   python manage.py runserver
+   ```
+
+2. Navigate to the login URL (e.g., `http://localhost:8000/auth/magic-link/`)
+
+3. Enter an email address and request a magic link
+
+4. Check that the magic link is sent (in the console if using the console email backend)
+
+5. Click the magic link to authenticate
+
+## Troubleshooting
+
+### Magic Links Not Being Sent
+
+- Check your email configuration settings
+- Ensure your SMTP server is accessible
+- Try using the console email backend for testing
+
+### Authentication Not Working
+
+- Verify that the MagicLinkBackend is in your AUTHENTICATION_BACKENDS
+- Check that the URLs are correctly included in your urls.py
+- Ensure the magic link hasn't expired or been used already
+
+### Template Errors
+
+- Make sure django_solomon is in your INSTALLED_APPS
+- Check that you're not overriding templates incorrectly
+- Verify that your custom templates extend the correct base templates
+
+## Next Steps
+
+Now that you have django-solomon installed and configured, you can:
+
+- Customize the templates to match your site's design
+- Integrate the magic link login with your existing authentication flow
+- Explore the programmatic API for advanced usage

django_solomon-0.2.0/docs/settings.md

@@ -0,0 +1,180 @@
+---
+hide:
+  - navigation
+---
+
+# Settings
+
+This guide provides detailed information about all the configurable settings in django-solomon.
+
+## Overview
+
+django-solomon provides several settings that you can customize in your Django settings file. These settings control various aspects of the magic link authentication system, including link expiration, user creation, templates, and more.
+
+## Core Settings
+
+### SOLOMON_LINK_EXPIRATION
+
+**Default:** `300` (seconds)
+
+The expiration time for magic links in seconds. After this time has elapsed, the link will no longer be valid.
+
+```python
+# Set magic links to expire after 10 minutes (600 seconds)
+SOLOMON_LINK_EXPIRATION = 600
+```
+
+### SOLOMON_ONLY_ONE_LINK_ALLOWED
+
+**Default:** `True`
+
+If enabled, only one active magic link is allowed per user. When a new magic link is requested, any existing active links for the same user will be marked as used.
+
+```python
+# Allow multiple active magic links per user
+SOLOMON_ONLY_ONE_LINK_ALLOWED = False
+```
+
+### SOLOMON_CREATE_USER_IF_NOT_FOUND
+
+**Default:** `False`
+
+If enabled, creates a new user when a magic link is requested for a non-existent email address.
+
+```python
+# Automatically create new users when they request a magic link
+SOLOMON_CREATE_USER_IF_NOT_FOUND = True
+```
+
+### SOLOMON_LOGIN_REDIRECT_URL
+
+**Default:** `settings.LOGIN_REDIRECT_URL`
+
+The URL to redirect to after successful authentication with a magic link.
+
+```python
+# Redirect to the dashboard after successful authentication
+SOLOMON_LOGIN_REDIRECT_URL = '/dashboard/'
+```
+
+## Permission Settings
+
+### SOLOMON_ALLOW_ADMIN_LOGIN
+
+**Default:** `True`
+
+If enabled, allows superusers (admin users) to log in using magic links. If disabled, superusers will need to use the standard Django admin login.
+
+```python
+# Disable magic link authentication for superusers
+SOLOMON_ALLOW_ADMIN_LOGIN = False
+```
+
+### SOLOMON_ALLOW_STAFF_LOGIN
+
+**Default:** `True`
+
+If enabled, allows staff users to log in using magic links. If disabled, staff users will need to use the standard Django admin login.
+
+```python
+# Disable magic link authentication for staff users
+SOLOMON_ALLOW_STAFF_LOGIN = False
+```
+
+## Template Settings
+
+django-solomon uses several templates for rendering emails and pages. You can customize these templates by providing your own versions.
+
+### SOLOMON_MAIL_TEXT_TEMPLATE
+
+**Default:** `"django_solomon/email/magic_link.txt"`
+
+The template to use for plain text magic link emails.
+
+```python
+# Use a custom plain text email template
+SOLOMON_MAIL_TEXT_TEMPLATE = "myapp/emails/magic_link.txt"
+```
+
+### SOLOMON_MAIL_MJML_TEMPLATE
+
+**Default:** `"django_solomon/email/magic_link.mjml"`
+
+The template to use for HTML magic link emails (MJML format). django-solomon uses MJML for creating responsive HTML emails.
+
+```python
+# Use a custom MJML email template
+SOLOMON_MAIL_MJML_TEMPLATE = "myapp/emails/magic_link.mjml"
+```
+
+### SOLOMON_LOGIN_FORM_TEMPLATE
+
+**Default:** `"django_solomon/base/login_form.html"`
+
+The template to use for the login form page.
+
+```python
+# Use a custom login form template
+SOLOMON_LOGIN_FORM_TEMPLATE = "myapp/auth/login_form.html"
+```
+
+### SOLOMON_INVALID_MAGIC_LINK_TEMPLATE
+
+**Default:** `"django_solomon/base/invalid_magic_link.html"`
+
+The template to use for the invalid magic link page, which is shown when a user tries to use an expired or already used magic link.
+
+```python
+# Use a custom invalid magic link template
+SOLOMON_INVALID_MAGIC_LINK_TEMPLATE = "myapp/auth/invalid_link.html"
+```
+
+### SOLOMON_MAGIC_LINK_SENT_TEMPLATE
+
+**Default:** `"django_solomon/base/magic_link_sent.html"`
+
+The template to use for the magic link sent confirmation page, which is shown after a user requests a magic link.
+
+```python
+# Use a custom magic link sent template
+SOLOMON_MAGIC_LINK_SENT_TEMPLATE = "myapp/auth/link_sent.html"
+```
+
+## Email Settings
+
+django-solomon uses Django's email system to send magic links. You should configure Django's email settings in your settings file:
+
+```python
+# Example email configuration for Gmail
+EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+EMAIL_HOST = 'smtp.gmail.com'
+EMAIL_PORT = 587
+EMAIL_USE_TLS = True
+EMAIL_HOST_USER = 'your-email@gmail.com'
+EMAIL_HOST_PASSWORD = 'your-app-password'
+DEFAULT_FROM_EMAIL = 'your-email@gmail.com'
+```
+
+For development, you can use Django's console email backend to display emails in the console:
+
+```python
+EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+```
+
+## Settings Summary
+
+Here's a summary of all available settings:
+
+| Setting                               | Default                                         | Description                                                                            |
+|---------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------|
+| `SOLOMON_LINK_EXPIRATION`             | `300`                                           | The expiration time for magic links in seconds                                         |
+| `SOLOMON_ONLY_ONE_LINK_ALLOWED`       | `True`                                          | If enabled, only one active magic link is allowed per user                             |
+| `SOLOMON_CREATE_USER_IF_NOT_FOUND`    | `False`                                         | If enabled, creates a new user when a magic link is requested for a non-existent email |
+| `SOLOMON_LOGIN_REDIRECT_URL`          | `settings.LOGIN_REDIRECT_URL`                   | The URL to redirect to after successful authentication                                 |
+| `SOLOMON_ALLOW_ADMIN_LOGIN`           | `True`                                          | If enabled, allows superusers to log in using magic links                              |
+| `SOLOMON_ALLOW_STAFF_LOGIN`           | `True`                                          | If enabled, allows staff users to log in using magic links                             |
+| `SOLOMON_MAIL_TEXT_TEMPLATE`          | `"django_solomon/email/magic_link.txt"`         | The template to use for plain text magic link emails                                   |
+| `SOLOMON_MAIL_MJML_TEMPLATE`          | `"django_solomon/email/magic_link.mjml"`        | The template to use for HTML magic link emails (MJML format)                           |
+| `SOLOMON_LOGIN_FORM_TEMPLATE`         | `"django_solomon/base/login_form.html"`         | The template to use for the login form page                                            |
+| `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE` | `"django_solomon/base/invalid_magic_link.html"` | The template to use for the invalid magic link page                                    |
+| `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`    | `"django_solomon/base/magic_link_sent.html"`    | The template to use for the magic link sent confirmation page                          |

django_solomon-0.2.0/docs/templates.md

@@ -0,0 +1,256 @@
+---
+hide:
+  - navigation
+---
+
+# Templates
+
+This guide provides detailed information about all the templates used in django-solomon and the context variables
+available in each template.
+
+## Overview
+
+django-solomon uses several templates for rendering emails and pages. You can customize these templates by providing
+your own versions or by specifying custom templates using the settings variables.
+
+## HTML Templates
+
+### Login Form Template
+
+**Default Path:** `django_solomon/base/login_form.html`
+
+**Settings Variable:** `SOLOMON_LOGIN_FORM_TEMPLATE`
+
+**Description:** This template renders the form for requesting a magic link.
+
+**Context Variables:**
+
+- `form`: The MagicLinkForm instance that contains the email field.
+
+**Example Usage:**
+
+```html
+{% extends "base.html" %}
+{% load i18n %}
+
+{% block title %}{% translate "Magic Link Login" %}{% endblock %}
+
+{% block content %}
+<div class="container">
+    <h1>{% translate "Magic Link Login" %}</h1>
+    <p>{% translate "Enter your email address to receive a magic link for logging in." %}</p>
+
+    <form method="post">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <button type="submit" class="btn btn-primary">{% translate "Send Magic Link" %}</button>
+    </form>
+</div>
+{% endblock content %}
+```
+
+### Magic Link Sent Template
+
+**Default Path:** `django_solomon/base/magic_link_sent.html`
+
+**Settings Variable:** `SOLOMON_MAGIC_LINK_SENT_TEMPLATE`
+
+**Description:** This template is displayed after a user requests a magic link, confirming that the link has been sent.
+
+**Context Variables:**
+
+- No specific context variables are passed to this template.
+
+**Example Usage:**
+
+```html
+{% extends "base.html" %}
+{% load i18n %}
+
+{% block title %}{% translate "Magic Link Sent" %}{% endblock %}
+
+{% block content %}
+<div class="container">
+    <h1>{% translate "Magic Link Sent" %}</h1>
+    <p>{% translate "If an account exists with the email address you provided, we've sent a magic link to that address."
+        %}</p>
+    <p>{% translate "Please check your email and click the link to log in." %}</p>
+</div>
+{% endblock content %}
+```
+
+### Invalid Magic Link Template
+
+**Default Path:** `django_solomon/base/invalid_magic_link.html`
+
+**Settings Variable:** `SOLOMON_INVALID_MAGIC_LINK_TEMPLATE`
+
+**Description:** This template is displayed when a user clicks on an invalid or expired magic link.
+
+**Context Variables:**
+
+- `error`: A string containing the error message explaining why the magic link is invalid.
+
+**Example Usage:**
+
+```html
+{% extends "base.html" %}
+{% load i18n %}
+
+{% block title %}{% translate "Invalid Magic Link" %}{% endblock %}
+
+{% block content %}
+<div class="container">
+    <h1>{% translate "Invalid Magic Link" %}</h1>
+    <p>{{ error }}</p>
+    <p>{% translate "Please request a new magic link to log in." %}</p>
+
+    <a href="{% url 'django_solomon:login' %}" class="btn btn-primary">
+        {% translate "Request New Magic Link" %}
+    </a>
+</div>
+{% endblock content %}
+```
+
+## Email Templates
+
+django-solomon uses two types of email templates: a plain text template and an MJML template for HTML emails.
+
+### Plain Text Email Template
+
+**Default Path:** `django_solomon/email/magic_link.txt`
+
+**Settings Variable:** `SOLOMON_MAIL_TEXT_TEMPLATE`
+
+**Description:** This template is used to generate the plain text version of the magic link email.
+
+**Context Variables:**
+
+- `magic_link_url`: The absolute URL of the magic link that the user needs to click.
+- `expiry_time`: The expiration time of the magic link in minutes.
+
+**Example Usage:**
+
+```
+{% load i18n %}
+{% translate "Hello," %}
+
+{% translate "You requested a magic link to log in to your account. Please click the link below to log in:" %}
+
+{{ magic_link_url }}
+
+{% blocktranslate with expiry_time=expiry_time %}This link will expire in {{ expiry_time }} minutes. If you did not request this link, you can safely ignore this email.{% endblocktranslate %}
+
+{% translate "Thank you," %}
+{% translate "The Django Solomon Team" %}
+
+---
+{% translate "This email was sent by Django Solomon." %}
+```
+
+### MJML Email Template
+
+**Default Path:** `django_solomon/email/magic_link.mjml`
+
+**Settings Variable:** `SOLOMON_MAIL_MJML_TEMPLATE`
+
+**Description:** This template is used to generate the HTML version of the magic link email using MJML, which ensures
+responsive emails across different email clients. For more information about MJML syntax and components, see the [MJML documentation](https://mjml.io/documentation/).
+
+**Context Variables:**
+
+- `magic_link_url`: The absolute URL of the magic link that the user needs to click.
+- `expiry_time`: The expiration time of the magic link in minutes.
+
+**Example Usage:**
+
+```html
+{% load i18n %}
+<mjml>
+    <mj-body>
+        <mj-section>
+            <mj-column>
+                <mj-text>
+                    <p>{% translate "Hello," %}</p>
+
+                    <p>
+                        {% blocktranslate %}
+                        You requested a magic link to log in to your account. Please click the link below
+                        to log in:
+                        {% endblocktranslate %}
+                    </p>
+                </mj-text>
+
+                <mj-button href="{{ magic_link_url }}">{% translate "Click here to log in" %}</mj-button>
+
+                <mj-text>
+                    <p>
+                        {% blocktranslate with expiry_time=expiry_time %}
+                        This link will expire in {{ expiry_time }} minutes. If you did not
+                        request this link, you can safely ignore this email.
+                        {% endblocktranslate %}
+                    </p>
+
+                    <p>
+                        {% translate "Thank you," %}
+                        <br>
+                        {% translate "The Django Solomon Team" %}
+                    </p>
+
+                    <p>
+                        ---
+                        <br>
+                        {% translate "This email was sent by Django Solomon." %}
+                    </p>
+                </mj-text>
+            </mj-column>
+        </mj-section>
+    </mj-body>
+</mjml>
+```
+
+## Customizing Templates
+
+You can customize the templates in two ways:
+
+1. **Override the default templates**: Create your own templates with the same paths in your project's templates
+   directory.
+
+2. **Specify custom templates in settings**: Use the settings variables to specify the paths to your custom templates.
+
+### Example: Overriding the Default Templates
+
+Create the following directory structure in your project:
+
+```
+templates/
+└── django_solomon/
+    ├── base/
+    │   ├── login_form.html
+    │   ├── magic_link_sent.html
+    │   └── invalid_magic_link.html
+    └── email/
+        ├── magic_link.txt
+        └── magic_link.mjml
+```
+
+### Example: Specifying Custom Templates in Settings
+
+```python
+# In your settings.py file
+SOLOMON_LOGIN_FORM_TEMPLATE = "myapp/auth/login_form.html"
+SOLOMON_MAGIC_LINK_SENT_TEMPLATE = "myapp/auth/link_sent.html"
+SOLOMON_INVALID_MAGIC_LINK_TEMPLATE = "myapp/auth/invalid_link.html"
+SOLOMON_MAIL_TEXT_TEMPLATE = "myapp/emails/magic_link.txt"
+SOLOMON_MAIL_MJML_TEMPLATE = "myapp/emails/magic_link.mjml"
+```
+
+## Base Template Requirements
+
+All the HTML templates extend a `base.html` template, which should be provided by your project. The base template should
+define at least the following blocks:
+
+- `title`: Used for the page title
+- `content`: Used for the main content of the page
+
+If your base template uses different block names, you'll need to modify the django-solomon templates accordingly.

{django_solomon-0.1.3 → django_solomon-0.2.0}/justfile

@@ -1,5 +1,5 @@
-set export
-set dotenv-load
+set export := true
+set dotenv-load := true
 
 VENV_DIRNAME := ".venv"
 
@@ -46,7 +46,7 @@ VENV_DIRNAME := ".venv"
 
 # run test suite
 @test: check_uv
-    uv run pytest --cov --cov-report=html --cov-report=term
+    uv run pytest --cov --cov-report=html --cov-report=term -n auto
 
 # run test suite
 @test-all: check_uv

{django_solomon-0.1.3 → django_solomon-0.2.0}/mkdocs.yml

@@ -26,6 +26,10 @@ theme:
     - content.code.copy
 nav:
   - Home: "index.md"
+  - Installation: "installation.md"
+  - Settings: "settings.md"
+  - Templates: "templates.md"
+  - Contributing: "contributing.md"
   - Changelog: "changelog.md"
 markdown_extensions:
   - def_list

{django_solomon-0.1.3 → django_solomon-0.2.0}/pyproject.toml

@@ -42,6 +42,7 @@ dev = [
     "pytest-randomly>=3.15.0",
     "pytest>=8.3.3",
     "django-stubs[compatible-mypy]>=5.1.1",
+    "pytest-xdist>=3.6.1",
 ]
 
 [build-system]

{django_solomon-0.1.3 → django_solomon-0.2.0}/tox.ini

@@ -15,6 +15,7 @@ deps =
     pytest
     pytest-mock
     pytest-django
+    pytest-xdist
     django40: Django>=4.0,<4.1
     django41: Django>=4.1,<4.2
     django42: Django>=4.2,<5.0
@@ -22,4 +23,4 @@ deps =
     django51: Django>=5.1,<5.2
     django52: Django>=5.2,<5.3
 commands =
-    pytest
+    pytest -n auto

{django_solomon-0.1.3 → django_solomon-0.2.0}/uv.lock

@@ -118,6 +118,7 @@ dev = [
     { name = "pytest-django" },
     { name = "pytest-mock" },
     { name = "pytest-randomly" },
+    { name = "pytest-xdist" },
 ]
 
 [package.metadata]
@@ -134,6 +135,7 @@ dev = [
     { name = "pytest-django", specifier = ">=4.9.0" },
     { name = "pytest-mock", specifier = ">=3.14.0" },
     { name = "pytest-randomly", specifier = ">=3.15.0" },
+    { name = "pytest-xdist", specifier = ">=3.6.1" },
 ]
 
 [[package]]
@@ -180,6 +182,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/02/cc/b7e31358aac6ed1ef2bb790a9746ac2c69bcb3c8588b41616914eb106eaf/exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b", size = 16453 },
 ]
 
+[[package]]
+name = "execnet"
+version = "2.1.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/bb/ff/b4c0dc78fbe20c3e59c0c7334de0c27eb4001a2b2017999af398bf730817/execnet-2.1.1.tar.gz", hash = "sha256:5189b52c6121c24feae288166ab41b32549c7e2348652736540b9e6e7d4e72e3", size = 166524 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/43/09/2aea36ff60d16dd8879bdb2f5b3ee0ba8d08cbbdcdfe870e695ce3784385/execnet-2.1.1-py3-none-any.whl", hash = "sha256:26dee51f1b80cebd6d0ca8e74dd8745419761d3bef34163928cbebbdc4749fdc", size = 40612 },
+]
+
 [[package]]
 name = "iniconfig"
 version = "2.1.0"
@@ -334,6 +345,19 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/22/70/b31577d7c46d8e2f9baccfed5067dd8475262a2331ffb0bfdf19361c9bde/pytest_randomly-3.16.0-py3-none-any.whl", hash = "sha256:8633d332635a1a0983d3bba19342196807f6afb17c3eef78e02c2f85dade45d6", size = 8396 },
 ]
 
+[[package]]
+name = "pytest-xdist"
+version = "3.6.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "execnet" },
+    { name = "pytest" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/41/c4/3c310a19bc1f1e9ef50075582652673ef2bfc8cd62afef9585683821902f/pytest_xdist-3.6.1.tar.gz", hash = "sha256:ead156a4db231eec769737f57668ef58a2084a34b2e55c4a8fa20d861107300d", size = 84060 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/6d/82/1d96bf03ee4c0fdc3c0cbe61470070e659ca78dc0086fb88b66c185e2449/pytest_xdist-3.6.1-py3-none-any.whl", hash = "sha256:9ed4adfb68a016610848639bb7e02c9352d5d9f03d04809919e2dafc3be4cca7", size = 46108 },
+]
+
 [[package]]
 name = "sqlparse"
 version = "0.5.3"

django_solomon-0.1.3/CHANGELOG.md

@@ -1 +0,0 @@
-# Changelog