add blog app, config models and views

.gitignore

@@ -0,0 +1,4 @@
+venv
+.vscode
+.env
+__pycache__

api/README.md

@@ -0,0 +1,28 @@
+# Api
+
+## Develop
+
+* Assumes you have `git clone`'d the repositiory.
+
+### Deps and Dev Env
+
+* Developed on `python 3.10.1`
+* Setting up a `venv`
+* ensure `django 4` is installed
+* `cd /api/`
+* `django startproject api`
+* Ensure deps are in order. `pip install -r requirements.txt`
+* `source .env` (called by `settings.py`)
+
+## Config
+
+Primaril refers to the envars and configs defined in `settings.py`.
+
+Such as:
+
+* added library declaration
+* Authentication middleware
+* Storage of static and media files
+* Access origin control
+* Logging
+* etc..

api/api/analytics/.gitignore

@@ -0,0 +1 @@
+__pychache__

api/api/analytics/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

api/api/analytics/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AnalyticsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'analytics'

api/api/analytics/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

api/api/analytics/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

api/api/analytics/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

api/api/api/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for api 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.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings')
+
+application = get_asgi_application()

api/api/api/settings.py

@@ -0,0 +1,128 @@
+"""
+Django settings for api project.
+
+Generated by 'django-admin startproject' using Django 4.0.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-ft@_y6#^c!ianhl7t&$l0-7_j80u1ba-icxszqru1u8q8g^9_*'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'rest_framework',
+    'analytics.apps.AnalyticsConfig',
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    '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 = 'api.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 = 'api.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
+
+
+# Add postgres for PROD and work with sqlite for devenv?
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.0/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/4.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.0/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

api/api/api/urls.py

@@ -0,0 +1,23 @@
+
+"""api URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.0/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 include, path
+
+urlpatterns = [
+    path('blogs/', include('blogs.urls')),
+    path('admin/', admin.site.urls),
+]

api/api/api/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for api 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/4.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.settings')
+
+application = get_wsgi_application()

api/api/blogs/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

api/api/blogs/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class BlogsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'blogs'

api/api/blogs/const.py

@@ -0,0 +1,5 @@
+
+# STATUS = (
+#     (0, "Draft"),
+#     (1, "Published")
+# )

api/api/blogs/models.py

@@ -0,0 +1,18 @@
+from django.db import models
+
+
+# move to `const.py`
+
+STATUS = (
+    (0,"Draft"),
+    (1,"Publish")
+)
+# Create your models here.
+
+class Post(models.Model):
+    title = models.CharField(max_length=200, unique=True)
+    author = models.ForeignKey('user.auth',on_delete=models.CASCADE)
+    updated_on =models.DateTimeField(auto_now= True)
+    created_on = models.DateTimeField(auto_now_add=True)
+    content = models.TextField()
+    status = models.IntegerChoices()

api/api/blogs/permissions.py

@@ -0,0 +1,6 @@
+from rest_framework import permissions
+
+class IsOwnerOrReadOnly(permissions.BasePermission):
+    """
+    Custom permission to only allow owners/authors of the object to edit it.
+    """

api/api/blogs/serializers.py

@@ -0,0 +1,10 @@
+from django.contrib.auth.models import User
+from .models import *
+
+from rest_framework import serializers
+
+class PostSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Post
+        # better to explicitly mention the fields
+        fields = '__all__'

api/api/blogs/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

api/api/blogs/urls.py

@@ -0,0 +1,6 @@
+from django.urls import path
+from . import views
+
+urlpatterns = [
+    path('', views.index, name='index')
+]

api/api/blogs/views.py

@@ -0,0 +1,19 @@
+from django.shortcuts import render
+from django.http import HttpResponse
+
+from rest_framework import permissions
+from rest_framework import viewsets
+
+from .models import *
+from .serializers import *
+
+
+# Create your views here.
+
+def index(request):
+    return HttpResponse("You're at the Blogs index")
+
+class PostViewSet(viewsets.ModelViewSet):
+    queryset = Post.objects.all()
+    serializer_class = PostSerializer
+    permission_classes = [permissions.IsAuthenticatedOrReadOnly]

api/api/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'api.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)
+
+
+if __name__ == '__main__':
+    main()

api/requirements.txt

@@ -0,0 +1,5 @@
+asgiref==3.4.1
+Django==4.0
+djangorestframework==3.13.1
+pytz==2021.3
+sqlparse==0.4.2