django-env-check 0.1.2

A tiny helper to validate required environment variables for Django.

🛡️ django-env-check

Validate your environment variables before Django starts

A tiny, zero-dependency helper that ensures all required environment variables are present before your Django app starts.

Installation • Usage • Features • Contributing

---

🎯 Why django-env-check?

Every Django project relies on environment variables, but most developers never validate whether they exist. This leads to:

• ❌ Missing SECRET_KEY or DATABASE_URL
• ❌ Silent misconfigurations in production
• ❌ Email failures due to missing credentials
• ❌ API integration issues
• ❌ Hard-to-debug runtime errors

django-env-check solves this with one line of code. ✨

---

🚀 Installation

pip install django-env-check

---

📖 Usage

Basic Usage

Add this at the top of your settings.py:

from env_check import check_env

check_env([
    "SECRET_KEY",
    "DATABASE_URL",
    "EMAIL_HOST_USER",
    "EMAIL_HOST_PASSWORD"
])

If any variable is missing, Django will refuse to start:

[django-env-check] Missing environment variables: SECRET_KEY, DATABASE_URL

🟡 Warning Mode (Development)

In development, you may want warnings instead of hard failures:

check_env(["SECRET_KEY"], warn_only=True)

Output:

⚠️  WARNING: [django-env-check] Missing environment variables: SECRET_KEY

💡 Auto-enable Warning Mode in DEBUG

from django.conf import settings

check_env(
    ["SECRET_KEY", "DATABASE_URL"],
    warn_only=settings.DEBUG
)

---

✨ Features

✅ Return Value

check_env(...) returns True when:

• All variables exist OR
• warn_only=True (even if variables are missing)

Use this in custom logic:

if check_env(["API_KEY"], warn_only=True):
    # Continue with setup
    pass

❗ Custom Exception Handling

Missing variables raise EnvMissingError:

from env_check import check_env, EnvMissingError

try:
    check_env(["SECRET_KEY"])
except EnvMissingError as e:
    print(f"⚠️  Config error: {e}")

---

🧪 Testing Your Installation

Test warning mode:

python -c "from env_check import check_env; check_env(['X'], warn_only=True)"

Test error mode (should raise EnvMissingError):

python -c "from env_check import check_env; check_env(['X'])"

---

📁 Project Structure

django-env-check/
├── env_check/
│   ├── __init__.py
│   └── checker.py
├── pyproject.toml
├── README.md
└── LICENSE

---

🤝 Contributing

Contributions are welcome! 🎉

• 🐛 Found a bug? Open an issue
• 💡 Have a feature idea? Submit a pull request
• 📝 Improve documentation? PRs are appreciated!

---

📜 License

MIT License – Free to use, modify, and distribute.

---

⭐ Support the Project

If django-env-check helps you catch bugs early and ship safer code, please:

• ⭐ Star this repo on GitHub
• 🐦 Share it with your Django community
• 💬 Leave feedback or suggestions

Your support encourages new features & improvements! ❤️

---

Made with ❤️ for the Django community