Installation
Requirements
- Python: 3.10 or higher
- Dependencies: Automatically installed (pyutilkit, ruamel-yaml, tomli for Python <3.11)
Installation Methods
Using uv (Recommended)
uv is an extremely fast Python package installer and resolver.
uv pip install dj_settings
Using pip
pip install dj_settings
Using Poetry
poetry add dj_settings
Using PEP 621 (pyproject.toml)
Add dj_settings to your project's dependencies in pyproject.toml:
[project]
dependencies = [
"dj_settings>=8.0.0",
]
Then install with your preferred tool:
# With uv
uv sync
# With pip
pip install -e .
# With Poetry
poetry install
Version Compatibility
| dj_settings Version | Python Version | Status |
|---|---|---|
| 8.x | ≥3.10 | Current |
| 7.x | ≥3.9 | Legacy |
| 6.x | ≥3.8 | Legacy |
| 5.x | ≥3.7 | Legacy |
For new projects, we recommend using the latest version (8.x) with Python 3.10+.
Verifying Installation
After installation, verify that dj_settings is correctly installed:
python -c "import dj_settings; print(dj_settings.__version__)"
This should print the installed version number.
Next Steps
- Read the Usage Guide to learn how to use dj_settings
- Check out the Quick Start examples in the README