django-base-kit 0.0.1

A fast initial setup for Django projects, providing a custom user model, authentication forms, and admin configuration.

django-base-kit

A bootstrap library for Django projects with:

• an abstract BaseModel using UUID v4 as the primary key
• a custom User model (AbstractUser + BaseModel)
• ready-to-use authentication views and templates:
  • login
  • logout
  • change password
  • password reset ("forgot password")

Installation

pip install django-base-kit

What this package provides

1) Reusable BaseModel

File: django_base_kit.models.BaseModel

Included fields:

• id (UUIDField, primary_key=True, default=uuid.uuid4)
• created_at
• updated_at
• active

Example usage in any app:

from django.db import models
from django_base_kit.models import BaseModel


class Product(BaseModel):
    name = models.CharField(max_length=120)
    price = models.DecimalField(max_digits=10, decimal_places=2)

    def __str__(self):
        return self.name

2) Custom User model

File: django_base_kit.models.User

• inherits from BaseModel
• inherits from AbstractUser
• unique email
• model app label: base_kit

So in settings.py, use:

AUTH_USER_MODEL = "base_kit.User"

3) Auth stack (views + forms + templates)

The package already includes forms, views, and templates for:

• login
• logout
• change password
• password reset (form, done, confirm, complete)

Routes are exposed through django_base_kit.urls.user_urlpatterns.

Consumer project setup

1) settings.py

Add/update:

INSTALLED_APPS = [
    # django apps...
    "widget_tweaks",
    "django_base_kit",
]

AUTH_USER_MODEL = "base_kit.User"

# Email sender used by password reset views
# The view reads FROM_MAIL and falls back to DEFAULT_FROM_EMAIL
FROM_MAIL = "[e-mail]"
DEFAULT_FROM_EMAIL = FROM_MAIL

# Local development (prints emails in the console)
EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"

# Recommended so Django can find package templates
TEMPLATES = [
    {
        # ...
        "APP_DIRS": True,
    },
]

2) Project urls.py

from django.contrib import admin
from django.urls import path
from django_base_kit.urls import user_urlpatterns

urlpatterns = [
    path("admin/", admin.site.urls),
] + user_urlpatterns

3) Migrations

In a new project:

python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

Available routes

• /accounts/signup/
• /accounts/login/
• /accounts/logout/
• /change_password/
• /reset_password/
• /reset_password/done
• /reset_password/confirm/<uidb64>/<token>/
• /reset_password/complete/

Important notes

• Set AUTH_USER_MODEL = "base_kit.User" before your first migration.
• If your project already migrated with auth.User, you will need a user migration plan.
• For password reset in production, configure SMTP (EMAIL_HOST, EMAIL_PORT, EMAIL_HOST_USER, EMAIL_HOST_PASSWORD, EMAIL_USE_TLS/SSL).

License

MIT