Skip to content

Commit c823d53

Browse files
x4nth055x4nth055
committed
add news api drf tutorial
1 parent fd9cf6a commit c823d53

24 files changed

+374
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ This is a repository of all the tutorials of [The Python Code](https://www.thepy
243243
- [How to Build an Email Address Verifier App using Django in Python](https://www.thepythoncode.com/article/build-an-email-verifier-app-using-django-in-python). ([code](web-programming/webbased-emailverifier))
244244
- [How to Build a Web Assistant Using Django and OpenAI GPT-3.5 API in Python](https://www.thepythoncode.com/article/web-assistant-django-with-gpt3-api-python). ([code](web-programming/webassistant))
245245
- [How to Make an Accounting App with Django in Python](https://www.thepythoncode.com/article/make-an-accounting-app-with-django-in-python). ([code](web-programming/accounting-app))
246+
- [How to Build a News Site API with Django Rest Framework in Python](https://www.thepythoncode.com/article/a-news-site-api-with-django-python). ([code](web-programming/news_project))
246247

247248
- ### [GUI Programming](https://www.thepythoncode.com/topic/gui-programming)
248249
- [How to Make a Text Editor using Tkinter in Python](https://www.thepythoncode.com/article/text-editor-using-tkinter-python). ([code](gui-programming/text-editor))

‎web-programming/news_project/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# [How to Build a News Site API with Django Rest Framework in Python](https://www.thepythoncode.com/article/a-news-site-api-with-django-python)

‎web-programming/news_project/db.sqlite3

144 KB
Binary file not shown.

‎web-programming/news_project/manage.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#!/usr/bin/env python
2+
"""Django's command-line utility for administrative tasks."""
3+
import os
4+
import sys
5+
6+
7+
def main():
8+
"""Run administrative tasks."""
9+
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'news_project.settings')
10+
try:
11+
from django.core.management import execute_from_command_line
12+
except ImportError as exc:
13+
raise ImportError(
14+
"Couldn't import Django. Are you sure it's installed and "
15+
"available on your PYTHONPATH environment variable? Did you "
16+
"forget to activate a virtual environment?"
17+
) from exc
18+
execute_from_command_line(sys.argv)
19+
20+
21+
if __name__ == '__main__':
22+
main()

‎web-programming/news_project/news_app/__init__.py

Whitespace-only changes.

‎web-programming/news_project/news_app/admin.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
from django.contrib import admin
2+
from .models import *
3+
4+
admin.site.register(Article)
5+
admin.site.register(Journalist)

‎web-programming/news_project/news_app/apps.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
from django.apps import AppConfig
2+
3+
4+
class NewsAppConfig(AppConfig):
5+
default_auto_field = 'django.db.models.BigAutoField'
6+
name = 'news_app'

‎web-programming/news_project/news_app/migrations/0001_initial.py

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Generated by Django 4.1.3 on 2023-01-12 10:42
2+
3+
from django.db import migrations, models
4+
import django.db.models.deletion
5+
6+
7+
class Migration(migrations.Migration):
8+
9+
initial = True
10+
11+
dependencies = [
12+
]
13+
14+
operations = [
15+
migrations.CreateModel(
16+
name='Journalist',
17+
fields=[
18+
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
19+
('first_name', models.CharField(max_length=60)),
20+
('last_name', models.CharField(max_length=60)),
21+
('bio', models.CharField(max_length=200)),
22+
],
23+
),
24+
migrations.CreateModel(
25+
name='Article',
26+
fields=[
27+
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
28+
('title', models.CharField(max_length=120)),
29+
('description', models.CharField(max_length=200)),
30+
('body', models.TextField()),
31+
('location', models.CharField(max_length=120)),
32+
('publication_date', models.DateField()),
33+
('author', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='articles', to='news_app.journalist')),
34+
],
35+
),
36+
]

‎web-programming/news_project/news_app/migrations/0002_alter_article_publication_date.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Generated by Django 4.1.3 on 2023-02-20 14:54
2+
3+
from django.db import migrations, models
4+
5+
6+
class Migration(migrations.Migration):
7+
8+
dependencies = [
9+
('news_app', '0001_initial'),
10+
]
11+
12+
operations = [
13+
migrations.AlterField(
14+
model_name='article',
15+
name='publication_date',
16+
field=models.DateField(auto_now_add=True),
17+
),
18+
]

‎web-programming/news_project/news_app/migrations/__init__.py

Whitespace-only changes.

‎web-programming/news_project/news_app/migrations/__pycache__/0001_initial.cpython-310.pyc

1.08 KB
Binary file not shown.

‎web-programming/news_project/news_app/migrations/__pycache__/0002_alter_article_publication_date.cpython-310.pyc

613 Bytes
Binary file not shown.

‎web-programming/news_project/news_app/migrations/__pycache__/__init__.cpython-310.pyc

161 Bytes
Binary file not shown.

‎web-programming/news_project/news_app/models.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
from django.db import models
2+
3+
4+
class Journalist(models.Model):
5+
first_name = models.CharField(max_length=60)
6+
last_name = models.CharField(max_length=60)
7+
bio = models.CharField(max_length=200)
8+
def __str__(self):
9+
return f"{ self.first_name } - { self.last_name }"
10+
11+
class Article(models.Model):
12+
author = models.ForeignKey(Journalist,
13+
on_delete=models.CASCADE,
14+
related_name='articles')
15+
title = models.CharField(max_length=120)
16+
description = models.CharField(max_length=200)
17+
body = models.TextField()
18+
location = models.CharField(max_length=120)
19+
publication_date = models.DateField(auto_now_add=True)
20+
21+
def __str__(self):
22+
return f"{ self.author } - { self.title }"

‎web-programming/news_project/news_app/serializers.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
from rest_framework import serializers
2+
from .models import *
3+
4+
class JournalistSerializer(serializers.Serializer):
5+
first_name = serializers.CharField(max_length=60)
6+
last_name = serializers.CharField(max_length=60)
7+
bio = serializers.CharField()
8+
9+
class ArticleSerializer(serializers.Serializer):
10+
title = serializers.CharField()
11+
description = serializers.CharField()
12+
body = serializers.CharField()
13+
location = serializers.CharField()
14+
author_id = serializers.IntegerField()
15+
16+
def create(self, validated_data):
17+
return Article.objects.create(**validated_data)
18+
19+
def update(self, instance, validated_data):
20+
instance.title = validated_data.get('title', instance.title)
21+
instance.description = validated_data.get('description', instance.description)
22+
instance.body = validated_data.get('body', instance.body)
23+
instance.author_id = validated_data.get('author_id', instance.author_id)
24+
instance.location = validated_data.get('location', instance.location)
25+
instance.publication_date = validated_data.get('publication_date', instance.publication_date)
26+
instance.save()
27+
return instance

‎web-programming/news_project/news_app/tests.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from django.test import TestCase
2+
3+
# Create your tests here.

‎web-programming/news_project/news_app/urls.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
from django.urls import path
2+
from .views import JournalistView, ArticleView, ArticleDetailView
3+
4+
app_name="news_app"
5+
6+
urlpatterns=[
7+
path('journalist/', JournalistView.as_view() ),
8+
path('article/', ArticleView.as_view() ),
9+
path('article/<int:pk>/', ArticleDetailView.as_view()),
10+
]

‎web-programming/news_project/news_app/views.py

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
from django.shortcuts import render
2+
3+
from rest_framework.response import Response
4+
from rest_framework.views import APIView
5+
6+
from .models import *
7+
from .serializers import JournalistSerializer, ArticleSerializer
8+
# Create your views here.
9+
from rest_framework.generics import get_object_or_404
10+
11+
12+
class JournalistView(APIView):
13+
def get (self, request):
14+
journalists = Journalist.objects.all()
15+
serializer = JournalistSerializer(journalists, many=True)
16+
return Response({"journalists":serializer.data})
17+
18+
class ArticleView(APIView):
19+
def get (self, request):
20+
articles = Article.objects.all()
21+
serializer = ArticleSerializer(articles, many=True)
22+
return Response({"articles":serializer.data})
23+
24+
def post(self, request):
25+
serializer = ArticleSerializer(data=request.data)
26+
if serializer.is_valid(raise_exception=True):
27+
saved_article = serializer.save()
28+
return Response({"success": "Article '{}' created successfully".format(saved_article.title)})
29+
30+
31+
class ArticleDetailView(APIView):
32+
def put(self, request, pk):
33+
saved_article = get_object_or_404(Article.objects.all(), pk=pk)
34+
serializer = ArticleSerializer(instance=saved_article, data=request.data, partial=True)
35+
if serializer.is_valid(raise_exception=True):
36+
article_saved = serializer.save()
37+
return Response({"success": "Article '{}' updated successfully".format(article_saved.title)})
38+
39+
def delete(self, request, pk):
40+
article = get_object_or_404(Article.objects.all(), pk=pk)
41+
article.delete()
42+
return Response({"message": "Article with id `{}` has been deleted.".format(pk)},status=204)

‎web-programming/news_project/news_project/__init__.py

Whitespace-only changes.

‎web-programming/news_project/news_project/asgi.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
ASGI config for news_project project.
3+
4+
It exposes the ASGI callable as a module-level variable named ``application``.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
8+
"""
9+
10+
import os
11+
12+
from django.core.asgi import get_asgi_application
13+
14+
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'news_project.settings')
15+
16+
application = get_asgi_application()

‎web-programming/news_project/news_project/settings.py

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
"""
2+
Django settings for news_project project.
3+
4+
Generated by 'django-admin startproject' using Django 4.1.2.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/4.1/topics/settings/
8+
9+
For the full list of settings and their values, see
10+
https://docs.djangoproject.com/en/4.1/ref/settings/
11+
"""
12+
13+
from pathlib import Path
14+
15+
# Build paths inside the project like this: BASE_DIR / 'subdir'.
16+
BASE_DIR = Path(__file__).resolve().parent.parent
17+
18+
19+
# Quick-start development settings - unsuitable for production
20+
# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
21+
22+
# SECURITY WARNING: keep the secret key used in production secret!
23+
SECRET_KEY = 'django-insecure-*#k+r4uiqb!=o1sn7!c(i%f)9t00s4gmzjzurmznvbphey3ie2'
24+
25+
# SECURITY WARNING: don't run with debug turned on in production!
26+
DEBUG = True
27+
28+
ALLOWED_HOSTS = []
29+
30+
31+
# Application definition
32+
33+
INSTALLED_APPS = [
34+
'django.contrib.admin',
35+
'django.contrib.auth',
36+
'django.contrib.contenttypes',
37+
'django.contrib.sessions',
38+
'django.contrib.messages',
39+
'django.contrib.staticfiles',
40+
'news_app',
41+
'rest_framework',
42+
]
43+
44+
MIDDLEWARE = [
45+
'django.middleware.security.SecurityMiddleware',
46+
'django.contrib.sessions.middleware.SessionMiddleware',
47+
'django.middleware.common.CommonMiddleware',
48+
'django.middleware.csrf.CsrfViewMiddleware',
49+
'django.contrib.auth.middleware.AuthenticationMiddleware',
50+
'django.contrib.messages.middleware.MessageMiddleware',
51+
'django.middleware.clickjacking.XFrameOptionsMiddleware',
52+
]
53+
54+
ROOT_URLCONF = 'news_project.urls'
55+
56+
TEMPLATES = [
57+
{
58+
'BACKEND': 'django.template.backends.django.DjangoTemplates',
59+
'DIRS': [],
60+
'APP_DIRS': True,
61+
'OPTIONS': {
62+
'context_processors': [
63+
'django.template.context_processors.debug',
64+
'django.template.context_processors.request',
65+
'django.contrib.auth.context_processors.auth',
66+
'django.contrib.messages.context_processors.messages',
67+
],
68+
},
69+
},
70+
]
71+
72+
WSGI_APPLICATION = 'news_project.wsgi.application'
73+
74+
75+
# Database
76+
# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
77+
78+
DATABASES = {
79+
'default': {
80+
'ENGINE': 'django.db.backends.sqlite3',
81+
'NAME': BASE_DIR / 'db.sqlite3',
82+
}
83+
}
84+
85+
86+
# Password validation
87+
# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
88+
89+
AUTH_PASSWORD_VALIDATORS = [
90+
{
91+
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
92+
},
93+
{
94+
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
95+
},
96+
{
97+
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
98+
},
99+
{
100+
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
101+
},
102+
]
103+
104+
105+
# Internationalization
106+
# https://docs.djangoproject.com/en/4.1/topics/i18n/
107+
108+
LANGUAGE_CODE = 'en-us'
109+
110+
TIME_ZONE = 'UTC'
111+
112+
USE_I18N = True
113+
114+
USE_TZ = True
115+
116+
117+
# Static files (CSS, JavaScript, Images)
118+
# https://docs.djangoproject.com/en/4.1/howto/static-files/
119+
120+
STATIC_URL = 'static/'
121+
122+
# Default primary key field type
123+
# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
124+
125+
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

‎web-programming/news_project/news_project/urls.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
"""news_project URL Configuration
2+
3+
The `urlpatterns` list routes URLs to views. For more information please see:
4+
https://docs.djangoproject.com/en/4.1/topics/http/urls/
5+
Examples:
6+
Function views
7+
1. Add an import: from my_app import views
8+
2. Add a URL to urlpatterns: path('', views.home, name='home')
9+
Class-based views
10+
1. Add an import: from other_app.views import Home
11+
2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
12+
Including another URLconf
13+
1. Import the include() function: from django.urls import include, path
14+
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
15+
"""
16+
from django.contrib import admin
17+
from django.urls import path,include
18+
19+
urlpatterns = [
20+
path('admin/', admin.site.urls),
21+
path('api/',include('news_app.urls')),
22+
]

‎web-programming/news_project/news_project/wsgi.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
WSGI config for news_project project.
3+
4+
It exposes the WSGI callable as a module-level variable named ``application``.
5+
6+
For more information on this file, see
7+
https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
8+
"""
9+
10+
import os
11+
12+
from django.core.wsgi import get_wsgi_application
13+
14+
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'news_project.settings')
15+
16+
application = get_wsgi_application()

‎web-programming/news_project/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
django
2+
djangorestframework

0 commit comments

Comments
 (0)