No project description provided
Project description
Python Web Scraper
This script utilizes the Playwright library for scraping websites and generating a knowledgebase. It is capable of outputting the scraped data in multiple formats, including JSON, plain text, and PDF.
Main Functions
scrape_it(config: Config)
Parameters
config
: An object containing URLs to scrape, output file names, file types, and a limit on pages to crawl.
Workflow
- Launch Chromium Browser: Uses Playwright to start a new browser instance.
- URL Iteration: For each URL in the
Config
object:- Sitemap Processing:
- Navigate to
sitemap.xml
. - Raise
NoSitemapError
if not found, else extract URLs.
- Navigate to
- Page Processing: For each URL in the sitemap:
- Stop if
max_pages_to_crawl
is reached. - Navigate to the URL and extract the page content.
- Create a
WebPage
object with URL and content. - Clean content and add to
Knowledgebase
object.
- Stop if
- Sitemap Processing:
- Output Generation:
- Calls
write_to_file(knowledgebase: Knowledgebase, config: Config)
to generate outputs. - Supports multiple output formats as specified in
config
(JSON, TXT, PDF).
- Calls
write_to_file(knowledgebase: Knowledgebase, config: Config)
Purpose
Writes the scraped data from Knowledgebase
to files in the specified formats.
Functionality
- Directory Creation: Ensures the directory for storing files exists.
- File Generation:
- JSON Output: Stores the
Knowledgebase
object in a JSON file. - Text Output: Creates a text file with all the page contents.
- PDF Output: Generates a PDF file with the content of each webpage.
- JSON Output: Stores the
Unique Filenames
- Uses
get_output_filename(file_name: str, file_type: str)
to ensure unique file names for each output file.
string_to_pdf(knowledgebase: Knowledgebase, file_name)
Purpose
Converts the content of webpages in a Knowledgebase
to a PDF file.
Functionality
- Handles UTF-8 encoding and falls back to DejaVu font if necessary.
- Generates a PDF with each page's URL and content.
Error Handling
- The script raises a
NoSitemapError
if a sitemap.xml file is not found for a given URL. - Errors and statuses are printed to the console for debugging and monitoring.
Requirements
- Playwright for Python
- FPDF library for PDF generation
- Pydantic for data model validation
Usage
poetry add tedfulk-kb-pycrawler
playwright install
import asyncio
from tedfulk_kb_pycrawler import scrape_it, Config
config = Config(
urls=[
"https://jxnl.github.io/instructor/",
],
output_file_name=["instructor"],
output_file_type=["pdf"],
max_pages_to_crawl=100,
)
asyncio.run(scrape_it(config))
Activate your virtual environment:
poetry shell
Run the script:
python main.py
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
Built Distribution
Close
Hashes for tedfulk_kb_pycrawler-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 199b24efe3e512e56b8e54f1e0f26300d475923a2198fdab46c1b0f97711f0c4 |
|
MD5 | be2dc970b27cee9c883187154cce204c |
|
BLAKE2b-256 | e33cda94905aa98646239b5b25532d160f69ee738682b20e388da25ea37033fa |
Close
Hashes for tedfulk_kb_pycrawler-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efd9fb3334d31e1891e8fbd8e1887d4e9c3f6303699f50784dd94647f16d28a6 |
|
MD5 | ddbe0dc0c7f47a35888f02b4694dcae1 |
|
BLAKE2b-256 | 481e3f10bed5be929d4ff1aeedd5f3ccdab4767c7090c4e45016b9db3b15ae88 |