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

django_solomon-0.3.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+# 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.3.0] - 2025-04-20
+
+### Added
+
+- IP address tracking for magic links
+- IP validation to enhance security (optional via `SOLOMON_ENFORCE_SAME_IP` setting)
+- Privacy-focused IP anonymization (enabled by default via `SOLOMON_ANONYMIZE_IP` setting)
+- New utility functions for IP handling and anonymization
+
+### Security
+
+- Option to validate magic links are used from the same IP address they were created from
+- IP anonymization to protect user privacy (removes last octet for IPv4, last 80 bits for IPv6)
+
+## [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.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-solomon
-Version: 0.1.3
+Version: 0.3.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,8 @@ 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)
+[![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.
 
@@ -64,6 +66,8 @@ A Django app for passwordless authentication using magic links.
 - Configurable link expiration time
 - Blacklist functionality to block specific email addresses
 - Support for auto-creating users when they request a magic link
+- IP address tracking and validation for enhanced security
+- Privacy-focused IP anonymization
 - Customizable templates for emails and pages
 - Compatible with Django's authentication system
 
@@ -138,11 +142,13 @@ 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                          |
+| `SOLOMON_ENFORCE_SAME_IP`             | `False`                                         | If enabled, validates that magic links are used from the same IP they were created from |
+| `SOLOMON_ANONYMIZE_IP`                | `True`                                          | If enabled, anonymizes IP addresses before storing them (removes last octet for IPv4)   |
 
 ## Usage
 
@@ -179,19 +185,30 @@ You can also use django-solomon programmatically in your views:
 ```python
 from django.contrib.auth import authenticate, login
 from django_solomon.models import MagicLink
+from django_solomon.utilities import get_client_ip
 
 # Create a magic link for a user
 magic_link = MagicLink.objects.create_for_user(user)
 
+# Create a magic link with IP address tracking
+ip_address = get_client_ip(request)
+magic_link = MagicLink.objects.create_for_user(user, ip_address=ip_address)
+
 # Authenticate a user with a token
 user = authenticate(request=request, token=token)
 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.3.0}/README.md

@@ -4,6 +4,8 @@
 [![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)
+[![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.
 
@@ -13,6 +15,8 @@ A Django app for passwordless authentication using magic links.
 - Configurable link expiration time
 - Blacklist functionality to block specific email addresses
 - Support for auto-creating users when they request a magic link
+- IP address tracking and validation for enhanced security
+- Privacy-focused IP anonymization
 - Customizable templates for emails and pages
 - Compatible with Django's authentication system
 
@@ -87,11 +91,13 @@ 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                          |
+| `SOLOMON_ENFORCE_SAME_IP`             | `False`                                         | If enabled, validates that magic links are used from the same IP they were created from |
+| `SOLOMON_ANONYMIZE_IP`                | `True`                                          | If enabled, anonymizes IP addresses before storing them (removes last octet for IPv4)   |
 
 ## Usage
 
@@ -128,19 +134,30 @@ You can also use django-solomon programmatically in your views:
 ```python
 from django.contrib.auth import authenticate, login
 from django_solomon.models import MagicLink
+from django_solomon.utilities import get_client_ip
 
 # Create a magic link for a user
 magic_link = MagicLink.objects.create_for_user(user)
 
+# Create a magic link with IP address tracking
+ip_address = get_client_ip(request)
+magic_link = MagicLink.objects.create_for_user(user, ip_address=ip_address)
+
 # Authenticate a user with a token
 user = authenticate(request=request, token=token)
 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.3.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.3.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