Forem: Shoukrey Tom

Add RSS Feed to your Django site

Shoukrey Tom — Wed, 24 Feb 2021 01:32:01 +0000

you can jump to step 4 if you want to test it with your existing project

Index

1- Intorduction
2- Environment Setup
3- Project Setup
4- Add RSS Feed

Introduction

RSS stands for Really Simple Syndication it allows users and applications to access updates to your website. or simply it informs users or visitors about updates in your website.

Environment Setup

create your virtual environment or use an existing one: python -m venv env
activate your virtual environment source env/bin/activate
install Django pip install django

Project Setup

create new folder mkdir django-add-rssfeed && cd django-add-rssfeed
create new project django-admin startproject config .
create new app python manage.py startapp blog and add it to INSTALLED_APPS
edit blog/models.py and paste these code in it:

from django.db import models
from django.urls import reverse

class Post(models.Model):
    STATUS_CHOICES = [('published', 'Published'), ('draft', 'Draft')]
    title = models.CharField(max_length=250)
    content = models.TextField()
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
    status = models.CharField(max_length=12, choices=STATUS_CHOICES, default='draft')

    def __str__(self):
        return self.title

    def get_absolute_url(self):
        return reverse('post-detail', kwargs={'slug': self.slug})

@receiver(post_save, sender=Post)
def save_slug(sender, instance=None, created=False, **kwargs):
    if created:
        instance.slug = slugify(instance.title)
        instance.save()

run python manage.py makemigrations then python manage.py migrate and don't forget to create a superuser python manage.py createsuperuser
add Post to admin.py and add some data for testing later.

Add RSS Feed

Create a new file blog/feeds.py and put this code in it.

from django.contrib.syndication.views import Feed
from django.utils.feedgenerator import Atom1Feed #optional

from .models import Post

class PostFeed(Feed):
    feed_type = Atom1Feed #optional
    title = "My Blog"
    link = ""
    description = "New Posts of My Blog"

    def items(self):
        return Post.objects.filter(status='published')

    def item_title(self, item):
        return item.title

    def item_description(self, item):
        return truncatewords(item.content, 30) # item.content

items() returns a list of objects that should be included in the feed as <item> elements. and so item_title and item_description are used to return a single object which will be included in <title> and <description> elements.
if you don't have get_absolute_url in your model you must override item_link(self, item) which returns reversed URL.
feed_type is an optional attribute, it is used to change Feed Type, By default, feeds produced by Django use RSS 2.0.

and now map it to a blog/urls.py:

from .feeds import PostFeed

urlpatterns = [
    .......
    path("feed/rss", PostFeed(), name="post-feed"),
    ......
]

here is how it looks like:

source code is upload to github: https://github.com/abdulshak1999/Python/tree/main/django/website_rssfeed

for more information check this: https://docs.djangoproject.com/en/3.1/ref/contrib/syndication/

Add Sitemap to Your Django Site

Shoukrey Tom — Tue, 23 Feb 2021 01:37:16 +0000

you can jump to step 4 if you want to test it with your existing project

Index

1- Intorduction
2- Environment Setup
3- Project Setup
4- Add Sitemap

Introduction

A sitemap tells search engines which pages and files you think are important in your site and also provides valuable information about these files.
it helps search engines to crawl your website quickly.

Environment Setup

create your virtual environment or use an existing one: python -m venv env
activate your virtual environment source env/bin/activate
install Django pip install django

Project Setup

create new folder mkdir django-add-sitemap && cd django-add-sitemap
create new project django-admin startproject config .
create new app python manage.py startapp blog and add it to INSTALLED_APPS
edit blog/models.py and paste these code in it:

from django.db import models
from django.urls import reverse

class Post(models.Model):
    STATUS_CHOICES = [('published', 'Published'), ('draft', 'Draft')]
    title = models.CharField(max_length=250)
    content = models.TextField()
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
    status = models.CharField(max_length=12, choices=STATUS_CHOICES, default='draft')

    def __str__(self):
        return self.title

    def get_absolute_url(self):
        return reverse('post-detail', kwargs={'slug': self.slug})

@receiver(post_save, sender=Post)
def save_slug(sender, instance=None, created=False, **kwargs):
    if created:
        instance.slug = slugify(instance.title)
        instance.save()

run python manage.py makemigrations then python manage.py migrate and don't forget to create a superuser python manage.py createsuperuser
add Post to admin.py and add some data for testing later.

Add Sitemap

first add django.contrib.sitemaps to INSTALLED_APPS
create blog/sitemaps.py then paste this code to it:

from django.contrib import sitemaps
from .models import Post


class PostSitemap(sitemaps.Sitemap):
    changefreq = "weakly"
    priority = 0.8

    def items(self):
        return Post.objects.filter(status='published')

    def lastmod(self, obj):
        return obj.updated

changefreq this attribute is used to tell how frequently your site is changing. other values are ["always", "hourly", "daily", "monthly", "yearly", "never"].
you can override default location method if have you don't have get_absolute_url in your model.

finally, map the URL for the sitemaps in the config/urls.py or blog/urls.py file.

# config/urls.py
from django.contrib.sitemaps.views import sitemap
from blog.sitemaps import PostSitemap

sitemaps = {
    "posts": PostSitemap,
}

urlpatterns = [
    ..........
    path("sitemap.xml", sitemap, {"sitemaps": sitemaps}, name="sitemap"),
    .........
]

here is how it looks like in a browser:

source code is upload to github: https://github.com/abdulshak1999/Python/tree/main/django/website_sitemap

for more information check this: https://docs.djangoproject.com/en/3.0/ref/contrib/sitemaps/

Useful Django 3rd party packages Part 2

Shoukrey Tom — Mon, 22 Feb 2021 20:33:04 +0000

1- django-suit (not compatible with Django3)

this package is an alternative to Django's built-in admin interface, It comes with a lot of widgets and customizations.

Live Demo: http://djangosuit.com/admin/
Doc: https://django-suit.readthedocs.io/en/develop/
Source: https://github.com/darklow/django-suit

2- django-import-export

this package is so helpful when you want to import or export your data, it supports multiple file formats (excel, json, csv, yaml, HTML, ...etc)

Doc: https://django-import-export.readthedocs.io/en/latest/
Source: https://github.com/django-import-export/django-import-export

3- django-summernote

this package allows you to embed Summernote into Django (admin or form). and if you don't know Summernote, Summernote is a JavaScript library that helps you create WYSIWYG editors online.

Doc: Not available (just use users guide on their repository)
Source: https://github.com/summernote/django-summernote

4- django-storages

this is essential when your media files and your website and hosted on different servers, for example, your website is hosted on Heroku and your media files are hosted on AWS or Dropbox for example. Django comes with a storage backend for FileSystem just, so you have to use this library.

Doc: https://django-storages.readthedocs.io/en/latest/
Source: https://github.com/jschneier/django-storages

5- django-allauth

django-allauth is a reusable Django app that allows for both local and social authentication, with flows that just work.

Doc: https://django-allauth.readthedocs.io/en/latest/index.html
Source: https://github.com/pennersr/django-allauth

Useful Django 3rd party packages part 1

Shoukrey Tom — Fri, 19 Feb 2021 03:56:10 +0000

as you already know that using 3rd party packages or libraries saves you a lot of time to make your work done.

here is a list of Django 3rd which could help you to boost your project development.

1. django-extension

it is one of the best and popular django packages, it has a lot of features including custom commands (shell_plus admin_generator, ...), custom fields, and more.

Doc: https://django-extensions.readthedocs.io/en/latest/index.html
Source: https://github.com/django-extensions/django-extensions

2. django-crispy-forms

if you are you using forms a lot and your skill on the front-end is so bad as mine, I better recommend you to use it, it controls the rendering of you form and make it nice looking.

Doc: https://django-crispy-forms.readthedocs.io/en/latest/
Source: https://github.com/django-crispy-forms/django-crispy-forms

3. django-seed

yeah, I know that you're probably sick up of visiting the admin page every time you've made changes to your models, me too and that is why you should use this package, it fills your DB with fake data which you can use for testing.

Doc: not available (read their README.md on the link below)
Source: https://github.com/Brobin/django-seed

4. django-autoslug

this package provides AutoSlugField which is exactly the same as Django SlugField but it is an auto-filled field, it is so helpful when you don't want to use signals or use slugify function on your view or form.

Doc: https://django-autoslug.readthedocs.io/en/latest/index.html
Source: https://github.com/justinmayer/django-autoslug

5. django-b2

this package provides a Django storage backend for BackBlaze I'm using it as an alternative to AWS.

Doc: not available (read their README.md on the link below)
Source: https://github.com/pyutil/django-b2

Portfolio Review

Shoukrey Tom — Wed, 27 Jan 2021 19:55:52 +0000

Hi developers, let me know if I have to customize it more.
Portfolio: Click here

https://shoukrey.herokuapp.com/

Learn Django in an easy way

Shoukrey Tom — Wed, 15 Jul 2020 23:14:20 +0000

If you want to learn basics of django in just a week, here are some steps to help you: (you must have a good knowledge in python)

learn how to install django from here.
know how to create django projects django-admin startproject my_project.
learn the structure of django project (check it here), and the use of manage.py file.
learn how to route urls
learn how to render templates
learn about models
learn how to add static files (css, images, js, ...ect) to the project
learn how to deal with admin page ( it's already setup for you just know how to create a superuser; and how to add contents (models) to it )
learn about sessions (cookies)

I just learned it in lees than a week.
Here is a youtube channel where I learned from Corey Schafer

Essential git commands

Shoukrey Tom — Fri, 12 Jun 2020 18:55:21 +0000

git init

this command initializes the repository.
git init
git add

this command adds file/files to the repository.
git add file_name.ext
or add all files in one go: git add ., git add --all
git commit

this command commits the changes to the repository with a message.
git commit -m "message"
git clone

this command clones a repository which is stored in a cloud (e.g: github) and creates a local copy.
git clone url_for_repository
git push

this command pushes the local repository to the cloud(e.g: github).
git push , git push -u remote_name branch_name
git pull

this command pulls or gets an changes from the copy of cloud-stored repository. git pull
git branch

this command creates/deletes a branch.
Create: git branch branch_name
Delete: git branch -d branch_name
git rm

this command is used to delete file/files from git repository.
git rm --cached file_name.ext , git rm --cached .
git status

this command is used to show changes to the git repository(new files, modified files, deleted files).
git status
git log

this command is used to show all commits.
git log
git checkout

this command is used to switch between branches.
git switch branch_name
git merge

this command is used to merge tow branches.
git merge target_branch source_branch

steps to learn a programming in a best way

Shoukrey Tom — Thu, 11 Jun 2020 04:51:08 +0000

here is a list of steps that you should follow before jumping into programming:

basics of your operating system
command-line
basics of any programming langauge
algorithms & data structures
version controls (e.g: git)

I just knew why it's important to know where to start? after I've spent three years of coding. because there ain't no one to guide me and I was a student of electronic engineering.

Forem: Shoukrey Tom

Add RSS Feed to your Django site

Index

Introduction

Environment Setup

Project Setup

Add RSS Feed

Add Sitemap to Your Django Site

Index

Introduction

Environment Setup

Project Setup

Add Sitemap

Useful Django 3rd party packages Part 2

1- django-suit (not compatible with Django3)

2- django-import-export

3- django-summernote

4- django-storages

5- django-allauth

Useful Django 3rd party packages part 1

as you already know that using 3rd party packages or libraries saves you a lot of time to make your work done.

here is a list of Django 3rd which could help you to boost your project development.

1. django-extension

2. django-crispy-forms

3. django-seed

4. django-autoslug

5. django-b2

Portfolio Review

Learn Django in an easy way

Essential git commands

git init

git add

git commit

git clone

git push

git pull

git branch

git rm

git status

git log

git checkout

git merge

steps to learn a programming in a best way