Skip to main content

Retrieve all URLs from a sitemap.

Project description


.. image:: :target: :alt: Documentation Status

.. image:: :target:

.. image:: :target:

.. image:: :target:

.. image:: :target: |

getsitemap is a Python library that retrieves all of the URLs that are found in all of the sitemaps on a website.

This project may be useful if you are building a search crawler or sitemap URL status code validators.

You can read the documentation for this project on Read the Docs <>_.

Installation 💻

To get started, pip install getsitemap:


pip install getsitemap

Quickstart ⚡

get all URLs recursively in all sitemaps

.. code-block:: python

   import getsitemap

   urls = getsitemap.get_individual_sitemap("")


get all URLs in a single sitemap

.. code-block:: python

import getsitemap

all_urls = getsitemap.retrieve_sitemap_urls("https://sitemap")


Code Quality

This library uses tox, pytest, and flake8 to assure code quality.

To run code quality checks, run the following command:

.. code-block:: bash


License 👩‍⚖️

This project is licensed under an MIT License <LICENSE>_.

Contributing 🛠️

We would love to have your help in improving getsitemap. Have an idea for a new feature or a bug to fix? Leave information in a GitHub Issue to start a discussion!

If you have

Contributors 💻

  • capjamesg

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

getsitemap-0.1.5.tar.gz (5.6 kB view hashes)

Uploaded Source

Built Distribution

getsitemap-0.1.5-py3-none-any.whl (5.4 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