Skip to main content

This package is used to read a sitemap and fetch all the urls in order to warm the cache of a website

Project description

Website SiteMap Preloader :rocket:

py.test codecov PyPI version PyPI - Python Version PyPI - License

Package for preloading website URLS from a provided SITEMAP URL. You can use this package to preload your website URLS in the background, so that your website will be faster for your users. You can set the depth in case the sitemap has more than one level.

Requirements :clipboard:

  • Python 3.8+

Installation :wrench:

Use the package manager pip to install preloader.

    pip install sitemap-preloader

How to use :question:

Follow the steps below to use the package on a python project.

    from preloader import Preloader
    sitemap_url = 'https://www.example.com/sitemap.xml'
    preloader = Preloader(sitemap_url, depth=2)

    preloader.fetch_pages()

Testing :white_check_mark:

We use pytest for testing. To run the tests, run the following command in the root directory of the project.

    pytest -s
    

Contributing :handshake:

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

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

sitemap-preloader-0.1.3.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

sitemap_preloader-0.1.3-py3-none-any.whl (3.2 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