Merge pull request #33 from jfmatth/enh/django-5

Update to django 5 and various other changes.

Author: chr15m

LICENSE

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+django = "<6"
+psycopg = {extras = ["binary", "pool"], version = "*"}
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"

Pipfile

@@ -1,2 +1,3 @@
-release: ./bin/provision-database
-wsgi: pikudjango.wsgi:application
+wsgi: pikupostgres.wsgi:application
+release: ./bin/stage_release.sh
+cron: 0 0 * * * ./bin/uwsgi_cron_midnight.sh

Pipfile.lock

@@ -1,27 +1,93 @@
-# Sample Django Application for `piku`
+# Piku Django Postgres
 
-> Contributed by @chr15m
+Provides an example Django app using Postgres locally on the PIKU server.
 
-This is a simple Django app that demonstrates running the Django `collectstatic` and `migrate` tasks in the `release` worker phase.
+## Requirements
+1. Piku
+2. Postgres installed on PIKU vm 
+``` ./piku-bootstrap install postgres.yml```
 
-To publish this app to `piku`, clone this repository run the following commands:
+## Installation
 
-```bash
-git remote add piku piku@your_server:sample_django_app
-git push piku master
+### Clone this repo and push it to your Piku server
 ```
+git clone ...
+git remote add piku piku@<your server here>:<app>
+git push piku
+```
+### Set the hostname for NGINX
+```
+piku config:set NGINX_SERVER_NAME=<your fqdn>
+```
+### Provision the Postgres Database  
+The Database is given the same name as your NGINX_SERVER_NAME via createdb and runs Django's migrate commmand ```python manage.py migrate```
+```
+piku run -- ./bin/provision-database.sh
+```
+
+### Create your superuser
+```
+piku shell
+./manage.py createsuperuser
+```
+
+### Navigate to the admin page
+Since debug hasn't been set, the default page won't work.  You can validate the deployment works by hitting the admin page
 
-Then you can set up an SSL cert and connect a domain by setting config variables like this:
+\<fqdn\>/admin
 
-```bash
-ssh piku@your_server config:set django_example NGINX_SERVER_NAME=your_server NGINX_HTTPS_ONLY=1
+# Piku features utilized
+This app utilizes several of Piku's ```Procfile``` features
 ```
+wsgi: pikupostgres.wsgi:application
+release: ./bin/stage_release.sh
+cron: 0 0 * * * ./bin/uwsgi_cron_midnight.sh
+```
+## wsgi
+Runs this python app as a WSGI process
+
+## release
+Each time you push your code, Piku will run a 'release' cycle and run this code.  ```./bin/stage_release.sh``` only runs Django's collectstatic function, but you can add more
 
-You can create a super user and set a password like this:
+## cron
+Piku uses UWSGI to schedule Cron jobs.  ```./bin/uwsgi_cron_midnight.sh``` runs a Django clearsessions command every day at 0:00 (midnight)
 
-```bash
-piku run django_example -- ./manage.py createsuperuser --email [email protected] --username admin --no-input
-piku run django_example -- ./manage.py changepassword admin
+## NGINX static file mapping
+The ```ENV``` file defines a feature that has NGINX serve this application static files directly from the folder
+```
+NGINX_STATIC_PATHS=/static:static
 ```
+# Django specifics
 
-You will not see a prompt after the second command but you can type a new password anyway and hit enter.
+## Django settings.py
+
+There are a few minor changes to Django to utilize Piku.  These are added to the end of ```settings.py```
+1. ```DEBUG``` - Debug is set to False unless the environment variable ```DEBUG``` is defined (```piku config:set DEBUG=true```)
+2. ```ALLOWED_HOSTS```  uses the NGINX_SERVER_NAME or DEBUG for security purposes
+3. ```DATABASES``` is updated if NGINX_SERVER_NAME is defined
+4. ```STATIC_ROOT``` is defined to reference the /static folder (tied to the above NGINX setting)
+
+## Database Changes
+Django makes it easy to modify the schema for your Models.  However, you'll need to update the running DB via 'manage.py migrate' before pushing the code changes.  Piku provides an easy way to accomplish this:
+
+```
+piku stop
+piku shell 
+./manage.py migrate
+```
+After this, you can ```git push piku``` and you should be OK  
+
+# Pipenv considerations
+If you use Pipenv for virtual environments, and given that Piku uses requirements.txt for it's python packages, you need to generate this before being pushed to piku.  A freindly devops method is to use GIT's pre-commit hook.
+
+Add the following file to ./.git/hooks/pre-commit (as +x)
+```
+#!/bin/bash
+
+# Generate requirements.txt from Pipfile
+pipenv sync
+pipenv requirements > requirements.txt
+
+# Add requirements.txt to the commit
+git add requirements.txt
+```

Procfile

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+echo "Db/server name: [${NGINX_SERVER_NAME}]"
+
+if [ "${NGINX_SERVER_NAME}" = "" ]
+then
+  echo "Skipping db creation as NGINX_SERVER_NAME is not set."
+else
+  psql "${NGINX_SERVER_NAME}" -c ";" 2>/dev/null && echo "Database ${NGINX_SERVER_NAME} already exists" || createdb "${NGINX_SERVER_NAME}"
+fi
+
+./manage.py migrate --no-input

README.md

@@ -0,0 +1 @@
+./manage.py collectstatic --no-input

bin/provision-database

@@ -0,0 +1 @@
+python manage.py clearsessions -v 3

bin/provision-database.sh

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

bin/stage_release.sh

@@ -0,0 +1,16 @@
+"""
+ASGI config for pikupostgres project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'pikupostgres.settings')
+
+application = get_asgi_application()