adding models

Author: davidslusser

.dockerignore

@@ -0,0 +1,11 @@
+# Ignore Python bytecode
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+
+# django_project stuff
+src/django_project/*.sqlite3
+src/django_project/*.log
+src/django_project/local_test
+src/django_project/tests

.gitignore

@@ -19,6 +19,8 @@ var/
 .installed.cfg
 *.egg
 /venv/
+/venv*/
+
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -65,7 +67,14 @@ target/
 
 # Project Specific
 local_test
-envs/.env.local
-django_project/django_logs
+src/envs/*
+!src/envs/.env.template
+src/logs
 django_project/yarn.lock
 django_project/__version__.py
+src/docker/.env*
+src/docker/db.yaml
+src/django_project/core/static/node_modules
+src/django_project/core/static/package.json
+src/django_project/core/static/package-lock.json
+*.sass-cache/*

LICENSE

@@ -1,2 +1,115 @@
-# django_repo_template
-standardized git template for creating new django projects
+# SpokanePython.com
+Home of SpokanePython, an online hub for Spokane's tech events and groups. It's not just a website; it's a community-driven, open-source initiative aimed at fostering learning and collaboration among aspiring and seasoned tech enthusiasts.
+
+
+See the live site here:
+https://www.spokanepython.com
+
+<br/>
+
+## Code Quality
+| Workflow | Description             | Status                                                                       |
+|----------|-------------------------|------------------------------------------------------------------------------|
+|Bandit|security checks|![Bandit](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/bandit.yaml/badge.svg)|
+|Isort|python import ordering|![Isort](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/isort.yaml/badge.svg)|
+|Mypy|static type checking|![Mypy](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/mypy.yaml/badge.svg)|
+|Radon|code complexity analysis|![Radon](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/radon.yaml/badge.svg)|
+|Ruff Format|code formatting|![Format](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/ruff_format.yaml/badge.svg)|
+|Ruff Lint|static code analysis|![Lint](https://github.com/SpokaneTech/SpokanePythonWeb/actions/workflows/ruff_lint.yaml/badge.svg)|
+
+
+<br/>
+
+## Local Development
+
+### prerequisites
+1. git installed on system
+2. python installed on system (3.10+ recommended)
+
+
+### local git setup
+1. clone the repo:
+
+    ```
+    git clone git@github.com:SpokaneTech/SpokanePythonWeb.git
+    ```
+
+2. git config (optional)
+To enable pre-commit code quality checks, update the location of git hooks with the following command:
+
+    ```shell
+    git config core.hooksPath .github/hooks
+    ```
+
+    Note: to make a commit with the precommit hooks temporarily disabled, run the following:
+
+    ```
+    git commit --no-verify
+    ```
+
+<br/>
+
+
+### local environment setup steps
+
+1. cd into the repo directory
+    ```
+    cd SpokanePythonWeb
+    ```
+
+2. create a python virtual environment
+    ```
+    python -m venv venv
+    ```
+
+3. activate the python virtual environment
+    
+    for linux, mac, or wsl:
+    ```
+    source venv/bin/activate
+    ```
+    for powershell:
+
+    ```powershell
+    venv\Scripts\activate
+    ```
+
+4. install the python dependencies
+    ```
+    pip install .[dev]
+    ```
+     ** mac users may need to use quotes, such as ```pip install ."[dev]"```
+
+5. (optional) create a custom .env file and update contents as applicable
+    ```
+    cp src/envs/.env.template src/envs/.env.local
+    ```
+
+6. cd to the django_project directory
+    ```
+    cd src/django_project
+    ```
+
+7. create a local database by running django migrations
+    ```
+    ./manage.py migrate
+    ```
+
+8. create a local admin user
+    ```
+    ./manage.py add_superuser --group admin
+    ```
+
+9. (optional) add platforms and groups to your local database
+    ```
+    ./manage.py runscript initialize_data
+    ```
+
+10. start the local demo server
+    ```
+    ./manage.py runserver
+    ```
+
+open a browser and navigate to http://127.0.0.1:8000 (log in with admin/admin)
+
+** you can stop the local demo server anytime via ```ctrl + c ```

README.md

@@ -1,9 +1,7 @@
 [project]
 dependencies = [
     "django~=5.2",
-    "django-auditlog==2.2.0",
     "django-braces",
-    "django-debug-toolbar",
     "django-environ",
     "django-extensions",
     "django-filter",
@@ -76,10 +74,16 @@ profile = "black"
 
 
 [tool.mypy]
-exclude = ["venv/*", "^django_project/*/migrations/*"]
+exclude = [
+    "venv/*", 
+    "src/django_project/local_test",
+    "src/django_project/.*/migrations/.*",
+    "src/django_project/.*/scripts/.*",
+    ]
 ignore_missing_imports = true
 
 
+
 [tool.pytest.ini_options]
 addopts = "-s -v -x --strict-markers -m 'not extra'"
 testpaths = ["django_project"]

pyproject.toml

@@ -0,0 +1,16 @@
+"""
+ASGI config for spokane_python 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", "core.settings")
+
+application = get_asgi_application()