This repository contains the implementation of Sitemap Generator Tool that produces XML sitemap of a website provided by a user. The features includes:
- producing an XML sitemap of a website specified by a user
- producing a zoomable URL graph-like diagram
- possibility to download both sitemaps
- listing collected links
- listing found documents
- listing found images
- mini-search engine that looks for words/phrases specified by a user
The examples of generated XML sitemaps, tree structures, images, logs can be seen in the static directory
To run the software following need to be installed first
- Python 3.11 (downloads: https://www.python.org/downloads/)
- Graphviz (downloads: https://graphviz.org/download/)
python -m venv /path/to/new/virtual/environment (venv is the name of the environment)
./path/to/new/virtual/environment/bin/activate (activate the environment)
pip install -r requirements.txt
python3.11 .\sitemap_generator\manage.py runserver
Following software was during development of the project:
-
Django. Python web framework.
Official website: https://www.djangoproject.com/ -
OpenSeaDragon. JavaScript framework for creating zoomable pictures.
Official website: https://openseadragon.github.io/ -
Graphviz. Open source graph visualization software.
Official website: https://graphviz.org/ -
requests. Python HTTP library.
GitHub repository: https://github.com/psf/requests
Documentation: https://requests.readthedocs.io/en/latest/ -
treelib. Python module providing tree data structure implementation.
GitHub repository: https://github.com/caesar0301/treelib
Documentation: https://treelib.readthedocs.io/en/latest/ -
urllib. Python package for working with URLs.
GitHub repository: https://github.com/python/cpython/tree/3.11/Lib/urllib/
Documentation: https://docs.python.org/3/library/urllib.html -
robotspy. Python package implementing Robots Exclusion Protocol parser.
GitHub repository: https://github.com/andreburgaud/robotspy
Documentation: https://pypi.org/project/robotspy/ -
multiprocessing. Python package for spawning processes to support parallelism.
GitHub repository: https://github.com/python/cpython/tree/3.11/Lib/multiprocessing/
Documentation: https://docs.python.org/3/library/multiprocessing.html -
Tailwind CSS. Open source frontend framework.
Official website: https://tailwindcss.com/
Copyright (c) 2011-2017 GitHub Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.