Intro - Django - Jonathan Laluces

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+django = "*"
+python-decouple = "*"
+djangorestframework = "*"
+gunicorn = "*"
+"psycopg2-binary" = "*"
+dj-database-url = "*"
+whitenoise = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.7"

Procfile

@@ -0,0 +1 @@
+web: gunicorn djorg.wsgi --log-file -

djorg/settings.py

@@ -0,0 +1,145 @@
+"""
+Django settings for djorg project.
+
+Generated by 'django-admin startproject' using Django 2.1.4.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.1/ref/settings/
+"""
+
+import os
+from decouple import config
+from rest_framework.authentication import SessionAuthentication, BasicAuthentication, TokenAuthentication
+from decouple import config and import dj_database_url
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = config('SECRET_KEY')
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = config('DEBUG', cast = bool)
+
+ALLOWED_HOSTS = ['.herokuapp.com']
+
+DATABASES['default'] = dj_database_url.config(default = config('DATABASE_URL'), conn_max_age=600)
+
+
+# Application definition
+
+INSTALLED_APPS = [        
+    'notes',
+    'rest_framework',
+    'rest_framework.authtoken',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+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',
+]
+
+ROOT_URLCONF = 'djorg.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',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'djorg.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.1/ref/settings/#databases
+
+# DATABASES = {
+#     'default': {
+#         'ENGINE': 'django.db.backends.sqlite3',
+#         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+#     }
+# }
+
+
+# Password validation
+# https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/2.1/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/2.1/howto/static-files/
+
+STATIC_URL = '/static/'
+STATIC_ROOT = os.path.join(BASE_DIR, 'static')
+
+REST_FRAMEWORK = {
+    'DEFAULT_PERMISSION_CLASSES': [ # --> What we want for permissions
+        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
+    ],
+
+    'DEFAULT_AUTHENTICATION_PROCESS': (
+        'rest_framework.authentication.TokenAuthentication',
+    ),
+
+    'DEFAULT_AUTHENTICATION_CLASSES': (
+        'rest_framework.authentication.BasicAuthentication',
+        'rest_framework.authentication.SessionAuthentication',
+        'rest_framework.authentication.TokenAuthentication',
+    ),
+}

djorg/urls.py

@@ -0,0 +1,31 @@
+"""djorg URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/2.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path, include, re_path
+
+from rest_framework.authtoken import views
+
+from rest_framework import routers
+from notes.api import PersonalNoteViewSet
+
+router = routers.DefaultRouter()
+router.register('notes', PersonalNoteViewSet) # --> Registered notes/ endpoint
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('api/', include(router.urls)),
+    re_path(r'^api-token-auth/', views.obtain_auth_token),
+]

djorg/wsgi.py

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

manage.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == '__main__':
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'djorg.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)

notes/admin.py

@@ -0,0 +1,12 @@
+from django.contrib import admin
+from .models import Note
+from .models import PersonalNote
+
+class NoteAdmin(admin.ModelAdmin):
+  readonly_fields = ('created_at', 'last_modified')
+
+# Register your models here.
+admin.site.register(Note, NoteAdmin) # --> Register the note with admin site
+# admin.site.register(SomeOtherModel!) --> Same thing
+admin.site.register(PersonalNote, NoteAdmin)
+

notes/api.py

@@ -0,0 +1,37 @@
+''' 
+This is where we'll put our RESTful api 
+that connects the model to the rest framework 
+'''
+
+# --> Define the fields we want to export via serializer
+from rest_framework import serializers, viewsets
+from .models import PersonalNote
+
+class PersonalNoteSerializer(serializers.HyperlinkedModelSerializer):
+  # --> Register model we want
+  # --> Register fields we want from the model
+
+  class Meta: # --> Holds metadata
+    model = PersonalNote
+    fields = ('title', 'content')
+
+  def create(self, validated_data): 
+    # --> Validated_data looks like {'title': 'title_stuff', 'content': 'content_stuff'}
+    user = self.context['request'].user # --> Found via debugger
+    note = PersonalNote.objects.create(user = user, **validated_data) # --> Pass in data as kwargs || use some more review on kwargs
+    return note
+
+
+class PersonalNoteViewSet(viewsets.ModelViewSet): # --> This is where we decide which records to return
+  # --> Attach it to serializer we made
+  serializer_class = PersonalNoteSerializer
+  queryset = PersonalNote.objects.none() # --> Retrieve none
+
+  def get_queryset(self): # --> Looking to over-ride the queryset so we can only have notes for their own user
+    user = self.request.user
+
+    if user.is_anonymous: # --> Not logged in
+      return PersonalNote.objects.none() # --> Return empty array
+    else:
+      return PersonalNote.objects.filter(user = user) # --> We want to filter all the notes
+      # --> Its filtering based on the user that is logged in