Django Sitemap

---

1. Creating a Sitemap Index with Multiple Sitemaps

from django.contrib.sitemaps import Sitemap
from django.contrib.sitemaps.views import sitemap

class PostSitemap(Sitemap):
    changefreq = 'weekly'
    priority = 0.5

    def items(self):
        return Post.objects.all()

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

sitemaps = {
    'posts': PostSitemap,
    'pages': PageSitemap,
}

urlpatterns = [
    path('sitemap.xml', sitemap, {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap'),
]

2. Creating a Sitemap for a Model with Images

from django.contrib.sitemaps import Sitemap, SitemapNode

class PostSitemapWithImages(Sitemap):
    def items(self):
        return Post.objects.all()

    def nodes(self, obj):
        node = SitemapNode('/post/%s/' % obj.id)
        if obj.image:
            node.image = SitemapNode(obj.get_image_url(), caption=obj.get_image_caption())
        return [node]

3. Creating a Sitemap for a Custom QuerySet

class CustomPostSitemap(Sitemap):
    def items(self):
        return Post.objects.filter(published=True, draft=False)

4. Creating a Sitemap with a Custom Change Frequency

class PostSitemapWithCustomChangeFrequency(Sitemap):
    changefreq = 'always'

5. Creating a Sitemap with a Custom Priority

class PostSitemapWithCustomPriority(Sitemap):
    priority = 1.0

6. Creating a Sitemap with a Custom Last Modified Date

class PostSitemapWithCustomLastMod(Sitemap):
    def lastmod(self, obj):
        return obj.created_at

7. Creating a Sitemap for a specific Django application

from django.contrib.sitemaps import SitemapIndex

class App1SitemapIndex(SitemapIndex):
    def items(self):
        return [
            Sitemap(('/app1/sitemap.xml')),
        ]

8. Creating a Sitemap for multiple Django applications

from django.contrib.sitemaps import SitemapIndex

class App1SitemapIndex(SitemapIndex):
    def items(self):
        return [
            Sitemap(('/app1/sitemap.xml')),
            Sitemap(('/app2/sitemap.xml')),
        ]

9. Creating a Sitemap using a Generic View

from django.contrib.sitemaps.views import sitemap

def sitemap_view(request):
    sitemaps = {
        'posts': PostSitemap,
        'pages': PageSitemap,
    }
    return sitemap(request, sitemaps)

10. Creating a Sitemap using a URLSet

from django.contrib.sitemaps import URLSet
from django.contrib.sitemaps.views import sitemap

def sitemap_view(request):
    urls = [
        {'location': '/post/1/', 'changefreq': 'daily', 'priority': 1.0},
        {'location': '/post/2/', 'changefreq': 'weekly', 'priority': 0.5},
    ]
    urlset = URLSet(urls)
    return sitemap(request, urlset)

11. Creating a Sitemap using a Static View

from django.http import HttpResponse
from django.contrib.sitemaps import Sitemap

def sitemap_view(request):
    sitemap = Sitemap()
    urls = sitemap.get_urls()
    response = HttpResponse(content_type='application/xml')
    response.write(urls.decode('utf-8'))
    return response

12. Creating a Sitemap using a Custom Template

from django.contrib.sitemaps.views import sitemap

def sitemap_view(request):
    sitemaps = {
        'posts': PostSitemap,
        'pages': PageSitemap,
    }
    return sitemap(request, sitemaps, template_name='my_custom_sitemap_template.html')

13. Creating a Sitemap using a Template Context

from django.contrib.sitemaps.views import sitemap

def sitemap_view(request):
    context = {
        'additional_info': 'This is some additional information to pass to the template',
    }
    return sitemap(request, context)

14. Creating a Sitemap using a Custom Template Context Processor

from django.contrib.sitemaps.views import sitemap
from django.utils.html import escape

def my_template_context_processor(request, sitemaps):
    return {
        'escaped_sitemaps': {k: escape(v) for k, v in sitemaps.items()},
    }

15. Creating a Sitemap with a Robots.txt file

from django.contrib.sitemaps import Sitemap, ping_google

Sitemap.ping_google = lambda urlset: ping_google(urlset)

def robots_txt(request):
    return HttpResponse('Sitemap: https://example.com/sitemap.xml\n', content_type='text/plain')

16. Creating a Sitemap with a Custom Sitemaps Header

from django.contrib.sitemaps import Sitemap

class CustomSitemap(Sitemap):
    def render_header(self, idx):
        return '<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">\n'

17. Creating a Sitemap with a Custom URLset Header

from django.contrib.sitemaps import URLSet

class CustomURLSet(URLSet):
    def render_header(self):
        return '<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">\n'

18. Creating a Sitemap with a Custom Namespace

from django.contrib.sitemaps import Sitemap

class CustomSitemap(Sitemap):
    namespaces = {'xhtml': 'http://www.w3.org/1999/xhtml'}

19. Creating a Sitemap with a Custom Sitemap Language

from django.contrib.sitemaps import Sitemap

class CustomSitemap(Sitemap):
    sitemaps_language = 'fr'

20. Creating a Sitemap with a Custom XSL Stylesheet

from django.contrib.sitemaps import Sitemap

class CustomSitemap(Sitemap):
    xsl_stylesheets = {'foo': 'foo.xsl'}

21. Creating a Sitemap with Specific URLs

from django.contrib.sitemaps import Sitemap

class PostSitemap(Sitemap):
    priority = 0.5

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

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

22. Creating a Sitemap for Static Pages

from django.contrib.sitemaps import Sitemap

class StaticSitemap(Sitemap):
    priority = 0.5

    def items(self):
        return ['/', '/about/', '/contact/']

    def lastmod(self, item):
        return datetime.now()

23. Creating a Sitemap for Multiple Sites

from django.contrib.sitemaps import Sitemap, ping_google

class Site1Sitemap(Sitemap):
    def items(self):
        return ['/', '/about/', '/contact/']

class Site2Sitemap(Sitemap):
    def items(self):
        return ['/', '/about/', '/contact/']

sitemaps = {
    'site1': Site1Sitemap,
    'site2': Site2Sitemap,
}

def sitemap_view(request, site_id):
    sitemap = sitemaps.get(site_id)
    if sitemap:
        return sitemap(request)
    return HttpResponseNotFound()

24. Creating a Sitemap for a Date-Based Site

from django.contrib.sitemaps import Sitemap

class PostSitemap(Sitemap):
    priority = 0.5

    def items(self):
        return Post.objects.filter(published__lte=datetime.now()).order_by('-published')

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

25. Creating a Sitemap for a Multilingual Site

from django.contrib.sitemaps import Sitemap

class PostSitemap(Sitemap):
    def items(self):
        return Post.objects.filter(published=True)

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

    def get_urls(self, site):
        urls = []
        languages = ['en', 'fr', 'es']
        for language in languages:
            urls.append({'location': f'/{language}/blog/', 'lastmod': datetime.now()})
        return urls

26. Creating a Sitemap for a Site with a Custom URL Prefix

from django.contrib.sitemaps import Sitemap

class PostSitemap(Sitemap):
    def items(self):
        return Post.objects.filter(published=True)

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

    def location(self, obj):
        return f'https://mysite.com/blog/{obj.slug}/'

27. Creating a Sitemap with a Custom Robots.txt Middleware

from django.contrib.sitemaps import Sitemap
from django.contrib.sitemaps.middleware import SitemapMiddleware

class MyRobotsTxtMiddleware(SitemapMiddleware):
    def process_response(self, request, response):
        if request.path == '/robots.txt':
            response = HttpResponse('Sitemap: https://mysite.com/sitemap.xml\n', content_type='text/plain')
            response['Last-Modified'] = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
        return response

28. Creating a Pingable Sitemap

from django.contrib.sitemaps import Sitemap, ping_google

class PostSitemap(Sitemap):
    def ping(self):
        ping_google(self.get_urls())

29. Creating a Sitemap using a Static Class

from django.contrib.sitemaps import Sitemap

class PostSitemap(Sitemap):
    filename = 'post_sitemap.xml'
    namespace = 'http://www.sitemaps.org/schemas/sitemap/0.9'
    location = '/sitemap.xml'

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

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

30. Creating a Sitemap using a Static Function

from django.contrib.sitemaps import Sitemap

def post_sitemap():
    sitemap = Sitemap(location='/sitemap.xml', namespace='http://www.sitemaps.org/schemas/sitemap/0.9')
    for post in Post.objects.filter(published=True):
        sitemap.add_item(post.url, post.updated_at)
    return sitemap

31. Creating a Sitemap using a Static Method

from django.contrib.sitemaps import Sitemap

class Blog:
    @staticmethod
    def sitemap():
        sitemap = Sitemap(location='/sitemap.xml', namespace='http://www.sitemaps.org/schemas/sitemap/0.9')
        for post in Post.objects.filter(published=True):
            sitemap.add_item(post.url, post.updated_at)
        return sitemap

32. Creating a Sitemap using a Decorator

from django.contrib.sitemaps import Sitemap

@sitemap.register
class PostSitemap(Sitemap):
    def items(self):
        return Post.objects.filter(published=True)

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

33. Creating a Sitemap using a Class-Based View

from django.contrib.sitemaps.views import SitemapView

class PostSitemapView(SitemapView):
    sitemap = PostSitemap

34. Creating a Sitemap using a Function-Based View

from django.contrib.sitemaps.views import sitemap

def post_sitemap_view(request):
    sitemap = PostSitemap()
    return sitemap(request)

35. Creating a Sitemap using a Template View

from django.contrib.sitemaps.views import sitemap

class PostSitemapTemplateView(TemplateView):
    template_name = 'sitemap.html'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['sitemap'] = PostSitemap()
        return context

36. Creating a Sitemap using a Generic View

from django.views.generic import TemplateView

class PostSitemapGenericView(TemplateView):
    template_name = 'sitemap.html'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['sitemap'] = PostSitemap.get_urls()
        return context