Metadata-Version: 2.1
Name: django-allauth-themes
Version: 0.1.2
Summary: Themes for Django-Allauth
Author-email: harrelchris <harrelchris+pypi@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Chris Harrel
        
        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.
        
Project-URL: Homepage, https://github.com/harrelchris/django-allauth-themes
Project-URL: Issues, https://github.com/harrelchris/django-allauth-themes/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django-allauth

# Django Allauth Themes

Themes for django-allauth

## Install

```shell
pip install django-allauth-themes
```

### Settings

Add `allauth_themes.bootstrap` before `allauth`:

```python
INSTALLED_APPS = [
    ...,
    "allauth_themes.bootstrap",
    "allauth",
    ...,
]
```

## Customization

### Bootswatch

You can achieve drastic changes with little effort using Bootswatch themes. Simply create a file in your templates directory to override the `allauth/layouts/css.html` file, with the following CDN link

```html
<link href="https://cdn.jsdelivr.net/npm/bootswatch@5.3.3/dist/cerulean/bootstrap.min.css" rel="stylesheet">
```

You can change `cerulean` to any of the available themes available on [Bootswatch.com](https://bootswatch.com/).

### Custom CSS

Alternatively, you can customize Bootstrap as you like and use that:

```html
<link rel="stylesheet" href="{% static 'css/custom_bootstrap.css' %}">
```

### Layout Customization

The layouts work with all Bootswatch themes, but you may want to customize them. As an example, these minor tweaks to the layouts may help the content stand out more. However, it doesn't work well with all Bootswatch themes (like quartz and vapor), so it's not included in the default layouts:

```html
  <div class="d-flex flex-grow-1 flex-shrink-0 py-5 bg-body-secondary">
    <div class="m-auto p-4 border shadow-lg bg-white">
      {% block content %}{% endblock %}
    </div>
  </div>
```

To apply these or other customizations, override the HTML files in your templates directory: `templates/allauth/layouts/entrance.html`. See it in action within the example project.
