Metadata-Version: 2.4
Name: django-admin-safe-login
Version: 0.3.7
Summary: Add captcha field for django admin's login page.
Author: rRR0VrFP
Maintainer: rRR0VrFP
License: MIT
Keywords: django admin extentions,django admin safe login
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=2.2.20
Requires-Dist: django-static-jquery3>=5.1.0
Requires-Dist: django-simple-captcha>=0.5.14
Requires-Dist: django-secure-password-input>=0.1.3
Requires-Dist: django-simple-tags>=0.6.0
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: requires-dist
Dynamic: summary

# django-admin-safe-login

Add captcha field and rsa encryption password field for django admin's login page.

## Install

```shell
pip install django-admin-safe-login
```

## Usage

**pro/settings.py**

```python
INSTALLED_APPS = [
    ...
    'django_static_jquery3',
    'django_secure_password_input',
    'django_simple_tags',
    'captcha',
    'django_admin_safe_login',
    ...
]

CAPTCHA_IMAGE_SIZE = (100, 30)  # required
DJANGO_ADMIN_SAFE_LOGIN_ENABLE_CAPTCHA = True # optional, default to True
DJANGO_ADMIN_SAFE_LOGIN_BACKGROUND_IMAGE = "django-admin-safe-login/img/example-background.jpg"  # optional, default to no-image.
DJANGO_ADMIN_SAFE_LOGIN_BOX_MARGIN_RIGHT = "200px" # optional, default to auto
DJANGO_ADMIN_SAFE_LOGIN_BOX_MARGIN_LEFT = "auto" # optional, default to auto
DJANGO_ADMIN_SAFE_LOGIN_BOX_MARGIN_TOP = "100px" # optional, default to auto
DJANGO_ADMIN_SAFE_LOGIN_BOX_MARGIN_BOTTOM = "100px" # optional, default to auto
DJANGO_ADMIN_SAFE_LOGIN_TEMPLATE = "" # optional, default to "admin/login.html".
```

**Note:**

1. Insert django_static_jquery3, django_secure_password_input, django-simple-tags, captcha and django_admin_safe_login into INSTALLED_APPS.
1. Application django_static_jquery3 provides static jquery.js.
1. Application django_secure_password_input provides rsa encryption and decryption function for password field.
1. Application django_admin_safe_login provides all functions about safe login.
1. Application captcha provides image captcha functions.
1. Application django-simple-tags provides custom template tags used in our admin/login.html.
1. Configuration item CAPTCHA_IMAGE_SIZE is required, and must set to (100, 30) so that it will not break the display style. If you want other size image, you have to rewrite some css code.
1. Configurations about password RSA encryption, see details at https://pypi.org/project/django-secure-password-input/.
1. Configurations about captcha, see detail at https://pypi.org/project/django-simple-captcha/.
1. Configurations about password reset, see detail at https://docs.djangoproject.com/en/3.0/ref/contrib/admin/ (search: Adding a password reset feature).

**pro/urls.py**

```python
from django.urls import path
from django.urls import include
from django.contrib.auth import views as auth_views

urlpatterns = [
    ...
    path(
        'admin/password_reset/',
        auth_views.PasswordResetView.as_view(),
        name='admin_password_reset',
    ),
    path(
        'admin/password_reset/done/',
        auth_views.PasswordResetDoneView.as_view(),
        name='password_reset_done',
    ),
    path(
        'reset/<uidb64>/<token>/',
        auth_views.PasswordResetConfirmView.as_view(),
        name='password_reset_confirm',
    ),
    path(
        'reset/done/',
        auth_views.PasswordResetCompleteView.as_view(),
        name='password_reset_complete',
    ),
    path('captcha/', include("captcha.urls")),
    ...
]
```

**Note:**

1. Include captcha.urls is required so that the captcha image can be displayed.
1. `Reset Password Link` only shows when you enabled `admin_password_reset` views in your urls.

## Changes about admin/login.html

We have override some part of admin/login.html. But the admin/login.html content may change in future releases. So you should known what part is overrided.

1. Our new admin/login.html extends from system's admin/login.html.
1. We override the extrastyle block to add extra js and css.
1. The function adding background image and changing login box position is implemented in our new extrastyle block.
1. We override the whole content block.
1. We copied the whole content block from django's default admin/login.html.
1. We added blocks inside content block: form, form-row-username, from-row-password, form-row-extra, form-row-captcha, password-reset-url, before-submit-row, submit-row, after-submit-row.



## Releases

### v0.1.0

- First release.

### v0.2.0

- Add rsa encryption and decrption functions for password field.
- Fix requirements.txt missing django-static-jquery3 problem.

### v0.3.0

- Add background image setting.
- Add login box position setting.
- Use admin/login.html override instead of creating a new template.
- Fix document.
- Fix translation.
- Fix setup.py problem that include demo and example code in the final package.

### v0.3.1

- Rename zh_Hans to zh_hans.
- Depends on django-static-jquery3>=5.0.0.

### v0.3.2

- Depends on django-secure-password-input>=0.1.1.

### v0.3.3

- Add `django-app-requires` support.
- Add License file. 

### v0.3.4

- Fix problems with django 3.2.
- Auto get captcha refresh url.

### v0.3.5

- Fix ugettext problem for Django 4.2.

### v0.3.6

- Doc update.

### v0.3.7

- Doc update.
