Merge branch dashboard into master

Author: staticf0x

.dockerignore

@@ -0,0 +1,2 @@
+data/
+**/*__pycache__*

.editorconfig

@@ -0,0 +1,15 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.js]
+indent_style = space
+indent_size = 4
+
+[package.json]
+indent_style = space
+indent_size = 2

.github/workflows/django.yml

@@ -31,11 +31,15 @@ jobs:
         poetry run ./manage.py test
       env:
         DS_SECRET_KEY: test
-    - name: Check PEP8
+    - name: Check flake8
       run: |
-        poetry run pycodestyle --exclude=ds/migrations/ dayliostats/ ds/
-      env:
-        DS_SECRET_KEY: test
+        poetry run flake8 --extend-exclude=ds/migrations ds
     - name: Check isort
       run: |
-        poetry run isort --check-only . --skip=ds/migrations/ --skip=node_modules/
+        poetry run isort --check-only --skip ds/migrations ds
+    - name: Check black
+      run: |
+        poetry run black --check --diff --extend-exclude=ds/migrations ds
+    - name: Check PEP257
+      run: |
+        poetry run pydocstyle ds

.gitignore

@@ -8,3 +8,6 @@ db.sqlite3
 __pycache__/
 cachegrind.out*
 data/db
+.coverage
+moods.json
+.venv

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+    - repo: https://github.com/psf/black
+      rev: 24.3.0
+      hooks:
+        - id: black
+          exclude: ds/migrations
+    - repo: https://github.com/PyCQA/isort
+      rev: 5.13.2
+      hooks:
+        - id: isort
+          exclude: ds/migrations
+

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Meesha
+Copyright (c) 2020 staticf0x
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -24,6 +24,17 @@ After cloning the repo:
 - `$ npm install` (this is only for development currently)
 - `$ poetry install`
 
+### Database
+
+Running from local MariaDB server, you'll need a database and a user, create
+them using this:
+
+```mysql
+CREATE DATABASE dayliostats CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
+CREATE USER 'dayliostats'@'localhost' IDENTIFIED BY 'dayliostats';
+GRANT ALL PRIVILEGES ON dayliostats.* TO 'dayliostats'@'localhost';
+```
+
 ### Secret key for Django
 
 Either set the `DS_SECRET_KEY` env variable directly, or read the key from a file.

dayliostats/settings.py

@@ -18,130 +18,133 @@
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
-dotenv.read_dotenv(os.path.join(BASE_DIR, '.env'))
+dotenv.read_dotenv(os.path.join(BASE_DIR, ".env"))
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = os.environ['DS_SECRET_KEY']
+SECRET_KEY = os.environ["DS_SECRET_KEY"]
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = False
 
 # This enabled the django admin console
 ADMIN = False
 
-ALLOWED_HOSTS = ['daylio-stats.herokuapp.com', 'localhost', '127.0.0.1']
-
+ALLOWED_HOSTS = ["daylio-stats.herokuapp.com", "localhost", "127.0.0.1"]
+# INTERNAL_IPS = ['127.0.0.1']
 
 # Application definition
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
-    'django_extensions',
-    'ds',
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django_extensions",
+    "debug_toolbar",
+    "ds",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'whitenoise.middleware.WhiteNoiseMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
 ]
 
-ROOT_URLCONF = 'dayliostats.urls'
+ROOT_URLCONF = "dayliostats.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
-                'ds.context_processors.global_vars',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+                "ds.context_processors.global_vars",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'dayliostats.wsgi.application'
+WSGI_APPLICATION = "dayliostats.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/3.0/ref/settings/#databases
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.mysql',
-        'NAME': os.getenv('DS_DB_NAME', 'dayliostats'),
-        'USER': os.getenv('DS_DB_USER', 'dayliostats'),
-        'PASSWORD': os.getenv('DS_DB_PASSWORD', 'dayliostats'),
-        'HOST': os.getenv('DS_DB_HOST', 'localhost'),
-        'PORT': 3306,
+    "default": {
+        "ENGINE": "django.db.backends.mysql",
+        "NAME": os.getenv("DS_DB_NAME", "dayliostats"),
+        "USER": os.getenv("DS_DB_USER", "dayliostats"),
+        "PASSWORD": os.getenv("DS_DB_PASSWORD", "dayliostats"),
+        "HOST": os.getenv("DS_DB_HOST", "localhost"),
+        "PORT": 3306,
+        "OPTIONS": {
+            "charset": "utf8mb4",
+        },
     }
 }
 
-if len(sys.argv) > 1 and sys.argv[1] == 'test':
-    DATABASES['default']['ENGINE'] = 'django.db.backends.sqlite3'
-    DATABASES['default']['NAME'] = ':memory:'
+if len(sys.argv) > 1 and sys.argv[1] == "test":
+    print("?")
+    DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}}
 
-DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
 
 # Password validation
 # https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
     },
 ]
 
 
 # Internationalization
 # https://docs.djangoproject.com/en/3.0/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
 USE_L10N = True
 
 USE_TZ = True
 
-SECURE_REFERRER_POLICY = 'same-origin'
+SECURE_REFERRER_POLICY = "same-origin"
 
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.0/howto/static-files/
-STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
-STATIC_URL = '/static/'
+STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles")
+STATIC_URL = "/static/"
 
-STATICFILES_DIRS = (
-    os.path.join(BASE_DIR, 'ds', 'static'),
-)
+STATICFILES_DIRS = (os.path.join(BASE_DIR, "ds", "static"),)
 
 TEST_RUNNER = "green.djangorunner.DjangoRunner"

dayliostats/urls.py

@@ -13,14 +13,19 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
+import debug_toolbar
 from django.contrib import admin
 from django.urls import include, path
 
-from dayliostats.settings import ADMIN
+from dayliostats.settings import ADMIN, DEBUG
 
 urlpatterns = [
     path('', include('ds.urls', namespace='ds')),
 ]
 
+if DEBUG:
+    urlpatterns += path('__debug__/', include(debug_toolbar.urls)),
+
 if ADMIN:
     urlpatterns += [path('admin/', admin.site.urls), ]

docker-compose.yml

@@ -0,0 +1,33 @@
+version: "3.9"
+
+services:
+    db:
+        image: mariadb
+        restart: always
+        volumes:
+            - ./data/db:/var/lib/mysql
+        env_file:
+            - .env
+        ports:
+            - 3306:3306
+        healthcheck:
+            test: "/usr/bin/mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD --execute \"SHOW DATABASES;\""
+            interval: 3s
+            timeout: 1s
+            retries: 5
+        security_opt:
+          - label=type:container_runtime_t
+
+    daylio-stats:
+        build: .
+        volumes:
+            - .:/usr/src/app
+        ports:
+            - 8000:8000
+        env_file:
+            - .env
+        security_opt:
+          - label=type:container_runtime_t
+        depends_on:
+            db:
+                condition: service_healthy