Update structure and features

.devcontainer/devcontainer.json

@@ -33,7 +33,6 @@
             "extensions": [
                 "ms-python.python",
                 "ms-python.vscode-pylance",
-                "ms-python.black-formatter",
                 "charliermarsh.ruff",
                 "tamasfe.even-better-toml"
             ],
@@ -73,9 +72,9 @@
                     "*"
                 ], // disable linting as it would be redundant with Ruff 
                 "python.pythonPath": "/usr/local/bin/python",
-                "python.envFile": "${workspaceFolder}/.env",
+                "python.envFile": "${workspaceFolder}/config/.env",
                 "python.analysis.autoImportCompletions": true,
-                "python.analysis.importFormat": "absolute",
+                "python.analysis.importFormat": "relative",
                 "python.analysis.indexing": true,
                 "python.analysis.packageIndexDepths": [
                     {
@@ -88,20 +87,28 @@
                     "${workspaceFolder}/dj_apps"
                     // TODO: add "${workspaceFolder}/dj_apps/<my_app>" for any new app,
                 ],
-                //*********************************************************************
-                // black
-                //*********************************************************************
-                "black-formatter.args": [
-                    "--config",
-                    "pyproject.toml"
-                ],
+                "ruff.enableExperimentalFormatter": true,
                 "[python]": {
-                    "editor.defaultFormatter": "ms-python.black-formatter",
+                    "editor.defaultFormatter": "charliermarsh.ruff",
                     "editor.formatOnSave": true,
                     "editor.codeActionsOnSave": {
                         "source.organizeImports": true
                     }
-                }
+                },
+                //*********************************************************************
+                // VSCODE icons
+                //*********************************************************************
+                "vsicons.presets.folders": false,
+                "vsicons.associations.folders": [
+                    {
+                        "icon": "src",
+                        "extensions": [
+                            "dj_apps"
+                        ],
+                        "format": "svg",
+                        "overrides": "new"
+                    }
+                ]
             }
         }
     }

.gitignore

@@ -3,3 +3,4 @@ __pycache__
 staticfiles/
 *.db
 .env
+*.DS_Store

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.0.2
+
+- FIXME
+
+
+## 0.0.1
+
+- Initial release

README.md

@@ -7,8 +7,7 @@ A minimal Django Starter Template for quick SaaS.
 
 - Main containers: Python/Django (service_app) and PostgreSQL (service_db)
 - Environment variables are handled with `.env` file (via django-environ)
-- Linting / Imports auto-sorting: Ruff
-- Auto-Formatting: Black
+- Linting / Imports auto-sorting/ Auto-formatting: Ruff
 - Package management: Poetry
 - No front-end configuration
 
@@ -22,6 +21,6 @@ A minimal Django Starter Template for quick SaaS.
 
 #### Once the container has been created:
 - Reload the container once (running the `reload window` VS Code command ) to ensure there is no error with extension activation due to a Dev Container bug.
-- Create a `.env` file based on `.env.example` file.
+- Create a `.env` file based on `.env.example` file in the `config` folder.
 - Run `./manage.py migrate`
 - Run `./manage.py runserver` and go to "http://localhost:8000/" to ensure everything works.

settings.py → config/settings.py

@@ -5,7 +5,8 @@
 import dj_database_url
 import environ
 
-BASE_DIR = Path(__file__).resolve().parent
+CONFIG_DIR = Path(__file__).resolve().parent
+BASE_DIR = CONFIG_DIR.parent
 
 
 ##########################################################################################
@@ -17,7 +18,7 @@
 # Take environment variables from .env file (if it exists)
 # That's why it is important to NOT version .env file
 # (otherwise prod environment will get local env file values!)
-environ.Env.read_env(os.path.join(BASE_DIR, ".env"))
+environ.Env.read_env(os.path.join(CONFIG_DIR, ".env"))
 
 ##########################################################################################
 # Security
@@ -45,7 +46,13 @@
     "corsheaders",
 ]
 
-MY_APPS = []  # Add your apps here
+APP_FOLDER = "dj_apps"
+
+# Create apps in dj_apps folder sothat they are automatically detected
+MY_APPS = os.listdir(BASE_DIR / Path(APP_FOLDER))
+
+for new_path in [APP_FOLDER] + [f"{APP_FOLDER}/{folder}" for folder in MY_APPS]:
+    sys.path.insert(0, os.path.join(BASE_DIR, new_path))
 
 INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + MY_APPS
 
@@ -61,7 +68,7 @@
 ]
 
 ROOT_URLCONF = "urls"
-WSGI_APPLICATION = "wsgi.application"
+WSGI_APPLICATION = "config.wsgi.application"
 
 ##########################################################################################
 # DX: Adding apps to the path is required for auto import

wsgi.py → config/wsgi.py

@@ -2,6 +2,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
 
 application = get_wsgi_application()

manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

pyproject.toml

@@ -34,9 +34,6 @@ psycopg = { extras = [
 ruff = "*" # https://github.com/charliermarsh/ruff
 ipdb = "*" # https://github.com/gotcha/ipdb
 
-[tool.black]
-target-version = ["py311"]
-
 
 [tool.ruff]
 line-length = 90