Dev-time conveniences for Django projects: autologin endpoint, dotfiles for LLM agents, gitignore self-check
Project description
django-dev-helpers
Dev-time conveniences for Django projects: autologin endpoint, dotfiles for LLM coding agents, agent help prompt, and gitignore self-check.
Features
- Autologin endpoint — one URL logs in a user via token, no interactive login needed
- Dotfiles —
.dev_helpers_token,.dev_helpers_port,.dev_helpers_pg_*,.dev_helpers_redis_*written to project root for easycatby LLM agents - Agent help prompt — copy-pasteable curl/psql/redis-cli commands printed at startup
- Gitignore self-check — warns if dotfiles are not in
.gitignore - Browser auto-open — opens autologin URL in browser after server starts
- Production-safe — default-off, requires explicit
enabled=True, raises onDEBUG=False
Installation
pip install django-dev-helpers
# or
uv add django-dev-helpers --group dev
Quick Start
- Add to
INSTALLED_APPS:
INSTALLED_APPS = [
# ...
"django_dev_helpers",
]
- Enable in settings:
DJANGO_DEV_HELPERS = {"enabled": True}
Or via environment variable:
DJANGO_DEV_HELPERS_ENABLED=1 python manage.py runserver
- Add URL patterns in your
urls.py:
from django_dev_helpers.urls import autologin_urlpatterns
urlpatterns = [
*autologin_urlpatterns(),
# ... your other URLs
]
That's it. On startup, the package will:
- Generate an autologin token
- Write dotfiles to your project root
- Check
.gitignore - Print agent help after first request
- Open browser with autologin URL
Usage
Autologin
T=$(cat .dev_helpers_token)
curl -L "http://localhost:8000/__autologin__/?token=$T"
Management Commands
python manage.py dev_helpers_doctor # Full diagnostic
python manage.py dev_helpers_print_help # Print agent prompt
python manage.py dev_helpers_check_gitignore # Check .gitignore entries
Documentation
- Quickstart
- Configuration reference
- Autologin endpoint
- Dotfiles + lookup chain
- Agent help / prompt
- Standalone usage
- Using with django-run-site
- Security
- Original design spec (frozen) — for design rationale
Configuration
All configuration via settings.DJANGO_DEV_HELPERS dict. See configuration docs for full reference.
DJANGO_DEV_HELPERS = {
"enabled": True,
"autologin": {
"user_lookup_field": "username",
"user_lookup_value": "admin",
"url_path": "__autologin__/",
"redirect_to": "/",
},
"dotfiles": {
"enabled": True,
},
"agent_help": {
"auto_print": True,
},
"browser_open": {
"enabled": True,
},
"gitignore": {
"mode": "warn", # warn | auto-add | error | off
},
}
Security
This package exposes an autologin backdoor for development. It is always off by default:
enabledmust be explicitly set toTrue(via settings or env var)- Raises
ImproperlyConfiguredifDEBUG=Falseand serving HTTP - Autologin view verifies token via
hmac.compare_digest(timing-safe) - Only accepts requests from localhost/127.0.0.1 by default
- Returns 404 (not 403/401) on any failure — endpoint appears non-existent
Never install this package in production. Add it only to dev dependencies.
Requirements
- Python >= 3.11
- Django >= 4.2
Supported versions
Combinations exercised on every push by the CI matrix
(.github/workflows/ci.yml):
| Python 3.11 | Python 3.12 | Python 3.13 | |
|---|---|---|---|
| Django 4.2 | ✓ | ✓ | ✓ |
| Django 5.0 | ✓ | ✓ | ✓ |
| Django 5.1 | ✓ | ✓ | ✓ |
| Django 5.2 | ✓ | ✓ | ✓ |
| Django 6.0 | — | ✓ | ✓ |
Django 6.0 requires Python ≥ 3.12, so the (3.11, 6.0) cell is excluded
from CI.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_dev_helpers-0.1.0.tar.gz.
File metadata
- Download URL: django_dev_helpers-0.1.0.tar.gz
- Upload date:
- Size: 78.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c85b1498d8ce48e204222b7e7c67cb5fd25544b9b6dba88fc8edc52c333cbc80
|
|
| MD5 |
2aba9154b51a9487cab176e4ce814a65
|
|
| BLAKE2b-256 |
40b3574c3236af25c88158897b5344348c46b6eeba1872c0ea6998f34a2fe174
|
File details
Details for the file django_dev_helpers-0.1.0-py3-none-any.whl.
File metadata
- Download URL: django_dev_helpers-0.1.0-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eaf72a19224863d100c6c30c989c6190ffde1fe6f518e6651c9387b7b5b771de
|
|
| MD5 |
e21384c3be031f32685c61fb0023fca8
|
|
| BLAKE2b-256 |
3d845396066165b1fd08717486091bb4fad7299f15498b61d608779db0116e9e
|