Generate sitemaps XML

app/sitemaps.py

@@ -0,0 +1,37 @@
+"""Create sitemaps."""
+
+from django.contrib.sitemaps import Sitemap
+from django.urls import reverse
+from . import models
+
+class AtlasSitemap(Sitemap):
+    """Sitemap for Cell Atlas pages."""
+    changefreq = "weekly"
+    priority = 0.8
+
+    def items(self):
+        """Return list of species to include in the sitemap."""
+        return models.Dataset.objects.all()
+
+    def location(self, obj):
+        """Return the URL for the main page of a species."""
+        return reverse('atlas_info', args=[obj.slug])
+
+    def lastmod(self, obj):
+        """
+        Return last modified date for the species page.
+        Useful to state last update to search engines.
+        """
+        return obj.date_updated
+
+
+class StaticViewSitemap(Sitemap):
+    """Sitemap for static pages."""
+    changefreq = "monthly"
+    priority = 0.5
+
+    def items(self):
+        return ['atlas', 'downloads', 'about', 'entry', 'reference', 'api']
+
+    def location(self, item):
+        return reverse(item)

app/urls.py

@@ -4,9 +4,16 @@
 """
 
 from django.urls import path
+from django.contrib.sitemaps.views import sitemap
+from .sitemaps import StaticViewSitemap, AtlasSitemap
 
 from . import views
 
+sitemaps = {
+    'static': StaticViewSitemap,
+    'dataset': AtlasSitemap,
+}
+
 urlpatterns = [
     path("", views.IndexView.as_view(), name="index"),
     # Cell Atlas
@@ -119,6 +126,8 @@
     path("about/", views.AboutView.as_view(), name="about"),
     path("search/", views.SearchView.as_view(), name="search"),
     path("health/", views.HealthView.as_view(), name="health"),
+    path('sitemap.xml', sitemap, {'sitemaps': sitemaps}, name='sitemap'),
+
     # Error pages
     path("403/", views.Custom403View.as_view()),
     path("404/", views.Custom404View.as_view()),

config/settings.py

@@ -49,6 +49,7 @@
 ALLOWED_HOSTS = get_env("DJANGO_ALLOWED_HOSTS", "", type="array")
 DEBUG = get_env("DJANGO_DEBUG", type="bool")
 SECRET_KEY = get_env("DJANGO_SECRET_KEY")
+SITE_ID = 1
 
 if get_env("ENVIRONMENT") == "prod":
     # Production environment
@@ -76,6 +77,8 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "django.contrib.sites",
+    "django.contrib.sitemaps",
     "rest_framework",
     "django_filters",
     "colorfield",