                |                                     |             
 __ `__ \    _` |        __|   __|   _` | \ \  \   /  |   _ \   __| 
 |   |   |  (   |       (     |     (   |  \ \  \ /   |   __/  |    
_|  _|  _| \__._|      \___| _|    \__._|   \_/\_/   _| \___| _|    

---------------------------------
markdown_crawler - by @paulpierre
---------------------------------
A multithreaded 🕸️ web crawler that recursively crawls a website and creates a 🔽 markdown file for each page
https://github.com/paulpierre
https://x.com/paulpierre

📝 Overview

This is a multithreaded web crawler that crawls a website and creates markdown files for each page. It was primarily created for large language model document parsing to simplify chunking and processing of large documents for RAG use cases. Markdown by nature is human readable and maintains document structure while keeping a small footprint.

✨ Features include

🧵 Threading support for faster crawling

⏯️ Continue scraping where you left off

⏬ Set the max depth of children you wish to crawl

📄 Support for tables, images, etc.

✅ Validates URLs, HTML, filepaths

⚙️ Configure list of valid base paths or base domains

🍲 Uses BeautifulSoup to parse HTML

🪵 Verbose logging option

👩‍💻 Ready-to-go CLI interface

🏗️ Use cases

RAG (retrieval augmented generation) - my primary usecase, use this to normalize large documents and chunk by header, pargraph or sentence
LLM fine-tuning - Create a large corpus of markdown files as a first step and leverage gpt-3.5-turbo or Mistral-7B to extract Q&A pairs
Agent knowledge - Leverage this with autogen for expert agents, for example if you wish to reconstruct the knowledge corpus of a videogame or movie, use this to generate the given expert corpus
Agent / LLM tools - Use this for online RAG learning so your chatbot continues to learn. Use SERP and scrape + index top N results w/ markdown-crawler
many more ..

🚀 Get started

If you wish to simply use it in the CLI, you can run the following command:

Install the package

pip install markdown-crawler

Execute the CLI

markdown-crawler -t 5 -d 3 -b ./markdown https://en.wikipedia.org/wiki/Morty_Smith

To run from the github repo, once you have it checked out:

pip install .
markdown-crawler -t 5 -d 3 -b ./markdown https://en.wikipedia.org/wiki/Morty_Smith

Or use the library in your own code:

from markdown_crawler import md_crawl
url = 'https://en.wikipedia.org/wiki/Morty_Smith'
md_crawl(url, max_depth=3, num_threads=5, base_path='markdown')

⚠️ Requirements

Python 3.x
BeautifulSoup4
requests
markdownify

🔍 Usage

The following arguments are supported

usage: markdown-crawler [-h] [--max-depth MAX_DEPTH] [--num-threads NUM_THREADS] [--base-path BASE_PATH] [--debug DEBUG]
                  [--target-content TARGET_CONTENT] [--target-links TARGET_LINKS] [--valid-paths VALID_PATHS]
                  [--domain-match DOMAIN_MATCH] [--base-path-match BASE_PATH_MATCH]
                  [--links ]
                  base-url

📝 Example

Take a look at example.py for an example implementation of the library. In this configuration we set:

max_depth to 3. We will crawl the base URL and 3 levels of children
num_threads to 5. We will use 5 parallel(ish) threads to crawl the website
base_dir to markdown. We will save the markdown files in the markdown directory
valid_paths an array of valid relative URL paths. We will only crawl pages that are in this list and base path
target_content to div#content. We will only crawl pages that have this HTML element using CSS target selectors. You can provide multiple and it will concatenate the results
is_domain_match to False. We will only crawl pages that are in the same domain as the base URL
is_base_path_match to False. We will include all URLs in the same domain, even if they don't begin with the base url
is_debug to True. We will print out verbose logging

And when we run it we can view the progress

We can see the progress of our files in the markdown directory locally

And we can see the contents of the HTML converted to markdown

❤️ Thanks

If you have any issues, please feel free to open an issue or submit a PR. You can reach me via DM on Twitter/X.

Follow me on Twitter / X
Give me a ⭐ on Github

⚖️ License

MIT License Copyright (c) 2023 Paul Pierre 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.

markdownify credits

markdown_crawler makes use of markdownify by Matthew Tretter. The original source code can be found here. It is licensed under the MIT license.

paulpierre/markdown-crawler