Skip to main content

TLCC reusable Django authentication app

Project description

django-tlcc-auth — Quick install (branch: feature/tlcc_auth-base)

Repository branch to copy: https://gitlab.com/vanhaesbroucklowie/django-packages/-/tree/feature/tlcc_auth-base

This file shows short, clear commands so any user can get the tlcc_auth folder from that branch and use it in a project.


Recommended (dev) — clone folder into your project and use editable install

Use this when you want the real source inside your project and edit it.

cd /path/to/your/project
# temporary sparse clone, get only tlcc_auth folder from the specific branch
git clone --filter=blob:none --sparse https://gitlab.com/vanhaesbroucklowie/django-packages.git tmp_repo
cd tmp_repo
git checkout feature/tlcc_auth-base
git sparse-checkout set tlcc_auth
mv tlcc_auth ../
cd ..
rm -rf tmp_repo
# install editable
pip install -e ./tlcc_auth

Result: ./tlcc_auth is a real folder in your project. Edit it and changes are active.


Quick copy (no git history) — download branch archive and extract only folder

Use this if you want a one-off copy without git metadata.

# download branch archive (GitLab auto-generated archive URL)
wget -O tmp.tar.gz "https://gitlab.com/vanhaesbroucklowie/django-packages/-/archive/feature/tlcc_auth-base/django-packages-feature-tlcc_auth-base.tar.gz"
mkdir tmp && tar -xzf tmp.tar.gz -C tmp
# find and move the tlcc_auth folder
mv tmp/*/tlcc_auth ./tlcc_auth
rm -rf tmp tmp.tar.gz
# optional: install editable
pip install -e ./tlcc_auth

Install from Git (package install, NOT copying folder)

This installs the package into site-packages. You cannot edit source inside project.

pip install "git+https://gitlab.com/vanhaesbroucklowie/django-packages.git@feature/tlcc_auth-base#egg=django-tlcc-auth"

Use this when you only need the package behavior and not to edit files.


Minimal project setup after you have tlcc_auth folder or package

Add to settings.py:

INSTALLED_APPS += ["tlcc_auth.apps.TlccAuthConfig"]

TLCC_AUTH = {
    "ALLOW_REGISTRATION": True,
    "ENABLE_JWT": False,
    "LOGIN_REDIRECT": "/",
    "TEMPLATES": {
        "login": "tlcc_auth/login.html",
        "register": "tlcc_auth/register.html",
    },
}

MEDIA_URL = "/media/"
MEDIA_ROOT = BASE_DIR / "media"
STATIC_URL = "/static/"

Include URLs in your project urls.py:

from django.urls import path, include
urlpatterns += [
    path("auth/", include(("tlcc_auth.urls","tlcc_auth"), namespace="tlcc_auth")),
]

Run migrations and server:

python manage.py migrate
python manage.py runserver

Visit: /auth/login/, /auth/register/, /auth/profile/, /auth/sessions/.


Short notes for different users

  • Developer (edit + commit): use Recommended (dev) flow. Keep tlcc_auth as subfolder or submodule. Use pip install -e.
  • Contributor (fork & PR): fork repository on GitLab, make changes in tlcc_auth, open merge request against feature/tlcc_auth-base or main.
  • Ops / Production: publish package and pip install django-tlcc-auth or install wheel. Don't copy source into project for production.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_tlcc_auth-0.1.5.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_tlcc_auth-0.1.5-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file django_tlcc_auth-0.1.5.tar.gz.

File metadata

  • Download URL: django_tlcc_auth-0.1.5.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for django_tlcc_auth-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fced93a243d59f2206176fd2c63eed38dffbcd24f13018de76d8e1e89ff0fc73
MD5 2c3454ebed7ddd65d25be814d9f51e65
BLAKE2b-256 b3511c6932a4ce3911ff52d751a7ec0a0c3824ec1d491e5d599dfa4a8f476606

See more details on using hashes here.

File details

Details for the file django_tlcc_auth-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for django_tlcc_auth-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3f5a98c0946e592da7058d5797ab3517f5c559e50707c3c3afcfcc3fff6cfc89
MD5 d665b688e71d0e261e29f413394b6f11
BLAKE2b-256 8b3d436b1bfc451e5776e79c9d8171d36a4e211bedbae250af3f278b0d212ed7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page