Skip to main content

JSL Django Sitemap is a Django utility which iterates over all the url patterns in your main Django project and creates a ready to use sitemap. The sitemap.xml is useful in crawlers such as Google, Bing, Yahoo. We hope you like our app! Leave a star on our GitHub repository. Thanks!

Project description

JSL Django Sitemap

Upload Python Package

JSL Django Sitemap is a sitemap.xml creator for Django projects which iterates over all the url patterns in your main Django project and creates a ready to use sitemap. The sitemap.xml is useful in crawlers such as Google, Bing, Yahoo. We hope you like our app! Leave a star on our GitHub repository. Thanks!

Our Home page JSoftwareLabs.com

Installation

You can install the JSL Django Sitemap from PyPI:

pip install jsl-django-sitemap

Example Usage

Add necessary imports

from jsl_django_sitemap.views import sitemaps
from django.contrib.sitemaps.views import sitemap
from django.urls import path

In your main django project urls.py file add below in urlpatterns

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

In your main settings.py file add below

JSL_DJANGO_SITEMAP_SETTINGS = {
	"ENABLE": True,
	"INCLUDE_APPS": ("ALL",)
}

add django built in sitemap in the INSTALLED_APPS

INSTALLED_APPS = [
	#...
	'django.contrib.sitemaps',
]

NOTE:

  1. "ALL" means to include all the urls
  2. If you want specific apps to be included in sitemap use below. Provide comma separated tuple containing your app name
  3. "INCLUDE_APPS": ("myapp1","myapp2")

View generated sitemap:

Start the development server and visit http://127.0.0.1:8000/sitemap.xml


Current Releases

1.1.1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsl_django_sitemap-1.1.1.tar.gz (4.8 kB view hashes)

Uploaded Source

Built Distribution

jsl_django_sitemap-1.1.1-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page