-
Notifications
You must be signed in to change notification settings - Fork 5.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Django User Management files #618
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
855a4f0
Add project files
acsany 22cca8d
Fix import
acsany d743133
Merge branch 'master' into django-user-management
bzaczynski fedf431
Remove namespaced URL relicts and delete unused file
acsany 5d5fbf7
Merge branch 'django-user-management' of github.com:realpython/materi…
acsany ce9cc17
Update Readme instructions and requirements
acsany 001d8d5
Merge branch 'master' into django-user-management
bzaczynski 7a671e4
Merge branch 'master' into django-user-management
brendaweles File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Get Started With Django User Management | ||
|
||
Follow the [step-by-step instructions](https://realpython.com/django-user-management/) on Real Python. | ||
|
||
## Setup | ||
|
||
You can run the provided example project on your local machine by following the steps outlined below. | ||
|
||
Create a new virtual environment: | ||
|
||
```bash | ||
$ python3 -m venv venv/ | ||
``` | ||
|
||
Activate the virtual environment: | ||
|
||
```bash | ||
$ source venv/bin/activate | ||
``` | ||
|
||
Install the dependencies for this project if you haven't installed them yet: | ||
|
||
```bash | ||
(venv) $ python -m pip install -r requirements.txt | ||
``` | ||
|
||
Navigate into the project's directory: | ||
|
||
```bash | ||
(venv) $ cd user_auth_intro/ | ||
``` | ||
|
||
Make and apply the migrations for the project to build your local database: | ||
|
||
```bash | ||
(venv) $ python manage.py makemigrations | ||
(venv) $ python manage.py migrate | ||
``` | ||
|
||
Run the Django development server: | ||
|
||
```bash | ||
(venv) $ python manage.py runserver | ||
``` | ||
|
||
Navigate to `http://localhost:8000/dashboard` to see the project in action. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
asgiref==3.8.1 | ||
Django==5.1.3 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should probably include all requirements for reproducibility:
|
||
sqlparse==0.5.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
#!/usr/bin/env python | ||
"""Django's command-line utility for administrative tasks.""" | ||
import os | ||
import sys | ||
|
||
|
||
def main(): | ||
"""Run administrative tasks.""" | ||
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings") | ||
try: | ||
from django.core.management import execute_from_command_line | ||
except ImportError as exc: | ||
raise ImportError( | ||
"Couldn't import Django. Are you sure it's installed and " | ||
"available on your PYTHONPATH environment variable? Did you " | ||
"forget to activate a virtual environment?" | ||
) from exc | ||
execute_from_command_line(sys.argv) | ||
|
||
|
||
if __name__ == "__main__": | ||
main() |
Empty file.
16 changes: 16 additions & 0 deletions
16
django-user-management/user_auth_intro/user_auth_intro/asgi.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
""" | ||
ASGI config for user_auth_intro project. | ||
|
||
It exposes the ASGI callable as a module-level variable named ``application``. | ||
|
||
For more information on this file, see | ||
https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/ | ||
""" | ||
|
||
import os | ||
|
||
from django.core.asgi import get_asgi_application | ||
|
||
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings") | ||
|
||
application = get_asgi_application() |
128 changes: 128 additions & 0 deletions
128
django-user-management/user_auth_intro/user_auth_intro/settings.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
""" | ||
Django settings for user_auth_intro project. | ||
|
||
Generated by 'django-admin startproject' using Django 5.1.3. | ||
|
||
For more information on this file, see | ||
https://docs.djangoproject.com/en/5.1/topics/settings/ | ||
|
||
For the full list of settings and their values, see | ||
https://docs.djangoproject.com/en/5.1/ref/settings/ | ||
""" | ||
|
||
from pathlib import Path | ||
|
||
# Build paths inside the project like this: BASE_DIR / 'subdir'. | ||
BASE_DIR = Path(__file__).resolve().parent.parent | ||
|
||
|
||
# Quick-start development settings - unsuitable for production | ||
# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/ | ||
|
||
# SECURITY WARNING: keep the secret key used in production secret! | ||
SECRET_KEY = ( | ||
"django-insecure-%&$tji0geb7vpx8@9-&qbf3_%3$s=5*5amo4tr)yg!6&6@bbhl" | ||
) | ||
|
||
# SECURITY WARNING: don't run with debug turned on in production! | ||
DEBUG = True | ||
|
||
ALLOWED_HOSTS = [] | ||
|
||
EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend" | ||
|
||
|
||
# Application definition | ||
|
||
INSTALLED_APPS = [ | ||
"users.apps.UsersConfig", | ||
"django.contrib.admin", | ||
"django.contrib.auth", | ||
"django.contrib.contenttypes", | ||
"django.contrib.sessions", | ||
"django.contrib.messages", | ||
"django.contrib.staticfiles", | ||
] | ||
|
||
MIDDLEWARE = [ | ||
"django.middleware.security.SecurityMiddleware", | ||
"django.contrib.sessions.middleware.SessionMiddleware", | ||
"django.middleware.common.CommonMiddleware", | ||
"django.middleware.csrf.CsrfViewMiddleware", | ||
"django.contrib.auth.middleware.AuthenticationMiddleware", | ||
"django.contrib.messages.middleware.MessageMiddleware", | ||
"django.middleware.clickjacking.XFrameOptionsMiddleware", | ||
] | ||
|
||
ROOT_URLCONF = "user_auth_intro.urls" | ||
|
||
TEMPLATES = [ | ||
{ | ||
"BACKEND": "django.template.backends.django.DjangoTemplates", | ||
"DIRS": [], | ||
"APP_DIRS": True, | ||
"OPTIONS": { | ||
"context_processors": [ | ||
"django.template.context_processors.debug", | ||
"django.template.context_processors.request", | ||
"django.contrib.auth.context_processors.auth", | ||
"django.contrib.messages.context_processors.messages", | ||
], | ||
}, | ||
}, | ||
] | ||
|
||
WSGI_APPLICATION = "user_auth_intro.wsgi.application" | ||
|
||
|
||
# Database | ||
# https://docs.djangoproject.com/en/5.1/ref/settings/#databases | ||
|
||
DATABASES = { | ||
"default": { | ||
"ENGINE": "django.db.backends.sqlite3", | ||
"NAME": BASE_DIR / "db.sqlite3", | ||
} | ||
} | ||
|
||
|
||
# Password validation | ||
# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators | ||
|
||
AUTH_PASSWORD_VALIDATORS = [ | ||
{ | ||
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", | ||
}, | ||
{ | ||
"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", | ||
}, | ||
{ | ||
"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator", | ||
}, | ||
{ | ||
"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator", | ||
}, | ||
] | ||
|
||
|
||
# Internationalization | ||
# https://docs.djangoproject.com/en/5.1/topics/i18n/ | ||
|
||
LANGUAGE_CODE = "en-us" | ||
|
||
TIME_ZONE = "UTC" | ||
|
||
USE_I18N = True | ||
|
||
USE_TZ = True | ||
|
||
|
||
# Static files (CSS, JavaScript, Images) | ||
# https://docs.djangoproject.com/en/5.1/howto/static-files/ | ||
|
||
STATIC_URL = "static/" | ||
|
||
# Default primary key field type | ||
# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field | ||
|
||
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" |
7 changes: 7 additions & 0 deletions
7
django-user-management/user_auth_intro/user_auth_intro/urls.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
from django.contrib import admin | ||
from django.urls import include, path | ||
|
||
urlpatterns = [ | ||
path("", include("users.urls")), | ||
path("admin/", admin.site.urls), | ||
] |
16 changes: 16 additions & 0 deletions
16
django-user-management/user_auth_intro/user_auth_intro/wsgi.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
""" | ||
WSGI config for user_auth_intro project. | ||
|
||
It exposes the WSGI callable as a module-level variable named ``application``. | ||
|
||
For more information on this file, see | ||
https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/ | ||
""" | ||
|
||
import os | ||
|
||
from django.core.wsgi import get_wsgi_application | ||
|
||
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_auth_intro.settings") | ||
|
||
application = get_wsgi_application() |
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
from django.apps import AppConfig | ||
|
||
|
||
class UsersConfig(AppConfig): | ||
default_auto_field = "django.db.models.BigAutoField" | ||
name = "users" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
from django.contrib.auth.forms import UserCreationForm | ||
|
||
|
||
class CustomUserCreationForm(UserCreationForm): | ||
class Meta(UserCreationForm.Meta): | ||
fields = UserCreationForm.Meta.fields + ("email",) |
Empty file.
Empty file.
12 changes: 12 additions & 0 deletions
12
django-user-management/user_auth_intro/users/templates/base.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="UTF-8" /> | ||
<title>User Management Intro</title> | ||
</head> | ||
<body> | ||
<h1>Welcome!</h1> | ||
{% block content %} | ||
{% endblock content %} | ||
</body> | ||
</html> |
6 changes: 6 additions & 0 deletions
6
django-user-management/user_auth_intro/users/templates/registration/_logout.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<form method="post" action="{% url 'logout' %}"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Logout" /> | ||
<input type="hidden" name="next" value="{% url 'dashboard' %}" /> | ||
</form> |
14 changes: 14 additions & 0 deletions
14
django-user-management/user_auth_intro/users/templates/registration/login.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Login</h2> | ||
<form method="post"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Login" /> | ||
<input type="hidden" name="next" value="{% url 'dashboard' %}" /> | ||
</form> | ||
<p> | ||
<a href="{% url 'password_reset' %}">Forgot your password?</a> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
</p> | ||
{% endblock content %} |
5 changes: 5 additions & 0 deletions
5
...go-user-management/user_auth_intro/users/templates/registration/password_change_done.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Password changed</h2> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
{% endblock content %} |
10 changes: 10 additions & 0 deletions
10
...go-user-management/user_auth_intro/users/templates/registration/password_change_form.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Change password</h2> | ||
<form method="post"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Change" /> | ||
</form> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
{% endblock content %} |
5 changes: 5 additions & 0 deletions
5
...user-management/user_auth_intro/users/templates/registration/password_reset_complete.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Password reset completed</h2> | ||
<a href="{% url 'login' %}">Login</a> | ||
{% endblock content %} |
10 changes: 10 additions & 0 deletions
10
...-user-management/user_auth_intro/users/templates/registration/password_reset_confirm.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Confirm password reset</h2> | ||
<form method="post"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Confirm" /> | ||
</form> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
{% endblock content %} |
5 changes: 5 additions & 0 deletions
5
django-user-management/user_auth_intro/users/templates/registration/password_reset_done.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Password reset link sent</h2> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
{% endblock content %} |
12 changes: 12 additions & 0 deletions
12
django-user-management/user_auth_intro/users/templates/registration/password_reset_form.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Send password reset link</h2> | ||
<form method="post"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Send Reset Link" /> | ||
</form> | ||
<p> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
</p> | ||
{% endblock content %} |
12 changes: 12 additions & 0 deletions
12
django-user-management/user_auth_intro/users/templates/registration/sign_up.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
<h2>Sign Up</h2> | ||
<form method="post"> | ||
{% csrf_token %} | ||
{{ form.as_p }} | ||
<input type="submit" value="Sign Up" /> | ||
</form> | ||
<p> | ||
<a href="{% url 'dashboard' %}">Back to dashboard</a> | ||
</p> | ||
{% endblock content %} |
12 changes: 12 additions & 0 deletions
12
django-user-management/user_auth_intro/users/templates/users/dashboard.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{% extends "base.html" %} | ||
{% block content %} | ||
Hello, {{ user.username|default:"Guest" }}! | ||
<hr /> | ||
{% if user.is_authenticated %} | ||
{% include "registration/_logout.html" %} | ||
<a href="{% url 'password_change' %}">Change password</a> | ||
{% else %} | ||
<a href="{% url 'login' %}">Login</a> | ||
<a href="{% url 'sign_up' %}">Sign up</a> | ||
{% endif %} | ||
{% endblock content %} |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
from django.urls import include, path | ||
|
||
from . import views | ||
|
||
urlpatterns = [ | ||
path("accounts/", include("django.contrib.auth.urls")), | ||
path("dashboard/", views.dashboard, name="dashboard"), | ||
path("sign_up/", views.sign_up, name="sign_up"), | ||
] |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a missing step: