From 4d1ec3474666ac8896cb014c2c9ced50b0f04a29 Mon Sep 17 00:00:00 2001 From: Fatima Date: Sun, 12 Oct 2025 18:43:17 +0500 Subject: [PATCH] Create A Django API in under 20 minutes --- .gitignore | 49 +++++++ py-projects/notable_django/api/__init__.py | 0 py-projects/notable_django/api/admin.py | 6 + py-projects/notable_django/api/apps.py | 6 + .../api/migrations/0001_initial.py | 23 ++++ .../notable_django/api/migrations/__init__.py | 0 py-projects/notable_django/api/models.py | 12 ++ py-projects/notable_django/api/resources.py | 10 ++ py-projects/notable_django/api/tests.py | 3 + py-projects/notable_django/api/views.py | 3 + py-projects/notable_django/manage.py | 22 ++++ .../notable_django/notable_django/__init__.py | 0 .../notable_django/notable_django/asgi.py | 16 +++ .../notable_django/notable_django/settings.py | 124 ++++++++++++++++++ .../notable_django/notable_django/urls.py | 26 ++++ .../notable_django/notable_django/wsgi.py | 16 +++ py-projects/requirements.txt | 7 + 17 files changed, 323 insertions(+) create mode 100644 .gitignore create mode 100644 py-projects/notable_django/api/__init__.py create mode 100644 py-projects/notable_django/api/admin.py create mode 100644 py-projects/notable_django/api/apps.py create mode 100644 py-projects/notable_django/api/migrations/0001_initial.py create mode 100644 py-projects/notable_django/api/migrations/__init__.py create mode 100644 py-projects/notable_django/api/models.py create mode 100644 py-projects/notable_django/api/resources.py create mode 100644 py-projects/notable_django/api/tests.py create mode 100644 py-projects/notable_django/api/views.py create mode 100755 py-projects/notable_django/manage.py create mode 100644 py-projects/notable_django/notable_django/__init__.py create mode 100644 py-projects/notable_django/notable_django/asgi.py create mode 100644 py-projects/notable_django/notable_django/settings.py create mode 100644 py-projects/notable_django/notable_django/urls.py create mode 100644 py-projects/notable_django/notable_django/wsgi.py create mode 100644 py-projects/requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..08b4de37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,49 @@ +# Ignore virtual environments +django_venv/ +venv/ +env/ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# Django migration files +*/migrations/ +*/migrations/*.pyc +*/migrations/*.py + +# Environment variables +.env +*.env + +# VS Code settings +.vscode/ + +# macOS system files +.DS_Store + +# Logs +*.log + +# Database files (if using SQLite) +*.sqlite3 + +# Node modules (if using React or similar in microservices) +node_modules/ + +# Test and coverage files +.coverage +coverage/ +htmlcov/ + +# Build directories +build/ +dist/ +*.egg-info/ + +# Travis CI build cache +.travis/ + +# Python wheel files +*.whl diff --git a/py-projects/notable_django/api/__init__.py b/py-projects/notable_django/api/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/py-projects/notable_django/api/admin.py b/py-projects/notable_django/api/admin.py new file mode 100644 index 00000000..3238821f --- /dev/null +++ b/py-projects/notable_django/api/admin.py @@ -0,0 +1,6 @@ +from django.contrib import admin +from .models import Note + +# Register your models here. + +admin.site.register(Note) \ No newline at end of file diff --git a/py-projects/notable_django/api/apps.py b/py-projects/notable_django/api/apps.py new file mode 100644 index 00000000..66656fd2 --- /dev/null +++ b/py-projects/notable_django/api/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class ApiConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'api' diff --git a/py-projects/notable_django/api/migrations/0001_initial.py b/py-projects/notable_django/api/migrations/0001_initial.py new file mode 100644 index 00000000..5f7c1de9 --- /dev/null +++ b/py-projects/notable_django/api/migrations/0001_initial.py @@ -0,0 +1,23 @@ +# Generated by Django 5.2.7 on 2025-10-12 13:22 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Note', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('title', models.CharField(max_length=200)), + ('body', models.TextField()), + ('created_at', models.DateTimeField(auto_now_add=True)), + ], + ), + ] diff --git a/py-projects/notable_django/api/migrations/__init__.py b/py-projects/notable_django/api/migrations/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/py-projects/notable_django/api/models.py b/py-projects/notable_django/api/models.py new file mode 100644 index 00000000..f8dd72e3 --- /dev/null +++ b/py-projects/notable_django/api/models.py @@ -0,0 +1,12 @@ +from django.db import models + +# Create your models here. + + +class Note(models.Model): + title = models.CharField(max_length=200) + body = models.TextField() + created_at = models.DateTimeField(auto_now_add=True) + + def __str__(self): + return f"{self.title} {self.body}" \ No newline at end of file diff --git a/py-projects/notable_django/api/resources.py b/py-projects/notable_django/api/resources.py new file mode 100644 index 00000000..bd9f7959 --- /dev/null +++ b/py-projects/notable_django/api/resources.py @@ -0,0 +1,10 @@ +from tastypie.resources import ModelResource +from .models import Note +from tastypie.authorization import Authorization + +class NoteResource(ModelResource): + class Meta: + queryset = Note.objects.all() + resource_name = 'note' + authorization = Authorization() + fields = ['title','body','created_at'] \ No newline at end of file diff --git a/py-projects/notable_django/api/tests.py b/py-projects/notable_django/api/tests.py new file mode 100644 index 00000000..7ce503c2 --- /dev/null +++ b/py-projects/notable_django/api/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/py-projects/notable_django/api/views.py b/py-projects/notable_django/api/views.py new file mode 100644 index 00000000..91ea44a2 --- /dev/null +++ b/py-projects/notable_django/api/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here. diff --git a/py-projects/notable_django/manage.py b/py-projects/notable_django/manage.py new file mode 100755 index 00000000..fef12cef --- /dev/null +++ b/py-projects/notable_django/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', 'notable_django.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() diff --git a/py-projects/notable_django/notable_django/__init__.py b/py-projects/notable_django/notable_django/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/py-projects/notable_django/notable_django/asgi.py b/py-projects/notable_django/notable_django/asgi.py new file mode 100644 index 00000000..09557eec --- /dev/null +++ b/py-projects/notable_django/notable_django/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for notable_django 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/5.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notable_django.settings') + +application = get_asgi_application() diff --git a/py-projects/notable_django/notable_django/settings.py b/py-projects/notable_django/notable_django/settings.py new file mode 100644 index 00000000..6f243d0f --- /dev/null +++ b/py-projects/notable_django/notable_django/settings.py @@ -0,0 +1,124 @@ +""" +Django settings for notable_django project. + +Generated by 'django-admin startproject' using Django 5.2.7. + +For more information on this file, see +https://docs.djangoproject.com/en/5.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/5.2/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/5.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-+szj=rwik6$&d7xeeab7c_01qq#y$p**cs(jt9e&c8=@-q67ey' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + + 'api', +] + +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 = 'notable_django.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'notable_django.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/5.2/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/5.2/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/5.2/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/5.2/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/py-projects/notable_django/notable_django/urls.py b/py-projects/notable_django/notable_django/urls.py new file mode 100644 index 00000000..f93ef0aa --- /dev/null +++ b/py-projects/notable_django/notable_django/urls.py @@ -0,0 +1,26 @@ +""" +URL configuration for notable_django project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/5.2/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 +from api.resources import NoteResource + +note_resource = NoteResource() + +urlpatterns = [ + path('admin/', admin.site.urls), + path('api/',include(note_resource.urls)) +] diff --git a/py-projects/notable_django/notable_django/wsgi.py b/py-projects/notable_django/notable_django/wsgi.py new file mode 100644 index 00000000..64df15b6 --- /dev/null +++ b/py-projects/notable_django/notable_django/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for notable_django 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/5.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notable_django.settings') + +application = get_wsgi_application() diff --git a/py-projects/requirements.txt b/py-projects/requirements.txt new file mode 100644 index 00000000..4d5daffd --- /dev/null +++ b/py-projects/requirements.txt @@ -0,0 +1,7 @@ +asgiref==3.10.0 +Django==5.2.7 +django-tastypie==0.15.1 +python-dateutil==2.9.0.post0 +python-mimeparse==2.0.0 +six==1.17.0 +sqlparse==0.5.3