Merge pull request #3 from toggle-corp/feature/initial-users

Author: susilnem

.github/workflows/ci.yaml

@@ -2,6 +2,9 @@ name: CI
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:

.github/workflows/release.yaml

@@ -7,6 +7,7 @@ on:
 
 permissions:
   contents: write
+  packages: write
 
 jobs:
   generate-release:
@@ -23,7 +24,7 @@ jobs:
         id: release
         shell: bash
         run: |
-          RELEASE_VERSION=${GITHUB_REF:11}
+          RELEASE_VERSION=${GITHUB_REF:10}
 
           IS_PRERELEASE=false
           if [[ "$RELEASE_VERSION" == *dev* ]]; then
@@ -46,7 +47,7 @@ jobs:
           args: -vv --latest --no-exec --github-repo ${{ github.repository }} --strip all
         env:
           GIT_CLIFF__REMOTE__GITHUB__OWNER: toggle-corp
-          GIT_CLIFF__REMOTE__GITHUB__REPO: toggle-django-utils
+          GIT_CLIFF__REMOTE__GITHUB__REPO: banjo-utils
 
       - name: Create Github Release
         uses: softprops/action-gh-release@v2

.gitmodules

@@ -1,4 +1,4 @@
 [submodule "fugit"]
     path = fugit
     url = https://github.com/toggle-corp/fugit.git
-    branch = v0.1.1
+    branch = v0.1.6

README.md

@@ -1,4 +1,4 @@
-# toggle-django-utils
+# Banjo utils
 
 Reusable Django utilities and management commands for Toggle projects.
 
@@ -8,43 +8,42 @@ Reusable Django utilities and management commands for Toggle projects.
 
 - Shared management command: `wait_for_resources`
   — Wait for database, Redis, Minio (S3) resources to be available before startup
+- Create Initial Users: `create_initial_users`
+    - Create Users with specified roles and permissions, useful to populate the database with default users during development or testing
 
 ---
 
 ## Installation
 
 **Using [uv](https://github.com/astral-sh/uv):**
 ```bash
-uv pip install "git+ssh://git@github.com/toggle-corp/toggle-django-utils.git@main"
+uv pip install "git+https://github.com/toggle-corp/banjo-utils.git@v0.1.0"
 ```
 
 Or add to your `pyproject.toml`:
 ```toml
 [project]
 dependencies = [
-    "toggle-django-utils",
+    "banjo-utils",
 ]
 
 [tool.uv.sources]
-toggle-django-utils = { git = "https://github.com/toggle-corp/toggle-django-utils", branch = "main" }
+banjo-utils = { git = "https://github.com/toggle-corp/banjo-utils", tag = "v0.1.0" }
 ```
 
 ---
 
 ## Setup in Django
 
-1. **Add to `INSTALLED_APPS` in your Django project's `settings.py`:**
+- **Add to `INSTALLED_APPS` in your Django project's `settings.py`:**
 
     ```python
     INSTALLED_APPS = [
         # ... your other apps ...
-        "toggle_django_utils",
+        "banjo_utils",
     ]
     ```
 
-2. (Optional) If your `settings.py` uses custom configs, ensure `"toggle_django_utils"` remains in the app list.
-
-
 ---
 
 ## Usage
@@ -55,15 +54,32 @@ python manage.py wait_for_resources --db --redis
 ```
 
 **Command options:**
-- `--db`      Wait for database
-- `--redis`   Wait for Redis server
-- `--minio`   Wait for Minio (S3 storage)
-- `--timeout`   Set max wait time (seconds)
+- `--db`: Wait for database
+- `--redis`: Wait for Redis server
+- `--minio`: Wait for Minio (S3 storage)
+- `--timeout`: Set max wait time (seconds)
 
 **Examples:**
 ```bash
 python manage.py wait_for_resources --db --redis
 python manage.py wait_for_resources --timeout 300 --minio
+python manage.py create_initial_users --users-json="
+[
+    {
+        "username": "admin",
+        "email": "test@example.com",
+        "password": "admin123",
+        "is_superuser": true,
+        "is_staff": true
+    },
+    {
+        "username": "user1",
+        "email": "user1@gmail.com",
+        "password": "user123",
+        "is_superuser": false,
+        "is_staff": false
+    }
+]'
 ```
 
 ---
@@ -83,6 +99,11 @@ python manage.py wait_for_resources --timeout 300 --minio
     ```bash
     uv run --all-groups --all-extras pytest
     ```
+4. Run commands for example project
+    ```bash
+    uv run --all-groups --all-extras python example/manage.py runserver
+    uv run --all-groups --all-extras python example/manage.py wait_for_resources --db --redis
+    ```
 
 ---
 

TODOS.md

@@ -1,7 +1,7 @@
 - We can use something like this inside <settings.py>
 
 ```
-TOGGLE_DJANGO_UTILS_CONFIG = {
+BANJO_UTILS_CONFIG = {
     "WAIT_FOR_RESOURCES": {
         "ALIAS": {
             "dev": ["db", "redis", "minio"],

example/main/settings.py

@@ -13,7 +13,7 @@
     "django.contrib.contenttypes",
     "django.contrib.sessions",
     "django.contrib.messages",
-    "toggle_django_utils",
+    "banjo_utils",
 ]
 
 MIDDLEWARE = [
@@ -26,7 +26,7 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": ":memory:",
+        "NAME": BASE_DIR / "db.sqlite3",
     },
 }
 

fugit

@@ -5,7 +5,7 @@ requires = [
 ]
 
 [project]
-name = "toggle-django-utils"
+name = "banjo-utils"
 version = "0.1.0"
 description = "Shared Django utilities for Toggle projects"
 readme = "README.md"
@@ -36,12 +36,12 @@ test = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/toggle-corp/toggle-django-utils"
-Repository = "https://github.com/toggle-corp/toggle-django-utils"
-Issues = "https://github.com/toggle-corp/toggle-django-utils/issues"
+Homepage = "https://github.com/toggle-corp/banjo-utils"
+Repository = "https://github.com/toggle-corp/banjo-utils"
+Issues = "https://github.com/toggle-corp/banjo-utils/issues"
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/toggle_django_utils"]
+packages = ["src/banjo_utils"]
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["E402"]

pyproject.toml

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class BanjoUtilsConfig(AppConfig):
+    name = "banjo_utils"
+    verbose_name = "Banjo Utils"
+    default_auto_field = "django.db.models.BigAutoField"