scrape is a rule-based web crawler and content extractor for the command-line. Rules may be set for controlling web traversal or simply filtering content. Generally, rules are defined as regular expressions and/or XPath language, among other options. Any content extracted may be consolidated to one or many files, with support for text, pdf, and HTML formats.
pip install scrape
or
pip install git+https://github.com/huntrar/scrape.git#egg=scrape
or
git clone https://github.com/huntrar/scrape
cd scrape
python setup.py install
You must install wkhtmltopdf to save files to pdf.
usage: scrape.py [-h] [-a [ATTRIBUTES [ATTRIBUTES ...]]]
[-c [CRAWL [CRAWL ...]]] [-ca] [-f [FILTER [FILTER ...]]]
[-ht] [-i] [-m] [-mp MAXPAGES] [-ml MAXLINKS] [-n] [-ni]
[-no] [-o [OUT [OUT ...]]] [-ow] [-p] [-pt] [-q] [-s] [-t]
[-v] [-x [XPATH]]
[QUERY [QUERY ...]]
a command-line web scraping tool
positional arguments:
QUERY URL's/files to scrape
optional arguments:
-h, --help show this help message and exit
-a [ATTRIBUTES [ATTRIBUTES ...]], --attributes [ATTRIBUTES [ATTRIBUTES ...]]
extract text using tag attributes
-c [CRAWL [CRAWL ...]], --crawl [CRAWL [CRAWL ...]]
regexp rules for following new pages
-ca, --crawl-all crawl all pages
-f [FILTER [FILTER ...]], --filter [FILTER [FILTER ...]]
regexp rules for filtering text
-ht, --html write files as HTML
-i, --images save page images
-m, --multiple save to multiple files
-mp MAXPAGES, --maxpages MAXPAGES
max number of pages to crawl
-ml MAXLINKS, --maxlinks MAXLINKS
max number of links to scrape
-n, --nonstrict allow crawler to visit any domain
-ni, --no-images do not save page images
-no, --no-overwrite do not overwrite files if they exist
-o [OUT [OUT ...]], --out [OUT [OUT ...]]
specify outfile names
-ow, --overwrite overwrite a file if it exists
-p, --pdf write files as pdf
-pt, --print print text output
-q, --quiet suppress program output
-s, --single save to a single file
-t, --text write files as text (default)
-v, --version display current version
-x [XPATH], --xpath [XPATH]
filter HTML using XPath
- Hunter Hammond (huntrar@gmail.com)
- Supports both Python 2.x and Python 3.x.
- Pages are saved temporarily as PART.html files during processing. Unless saving pages as HTML, these files are removed automatically upon conversion or exit.
- Images are automatically included when saving as PDF or HTML; this involves making additional HTTP requests, adding a significant amount of processing time. If you wish to forgo this feature use the --no-images flag, or set the environment variable SCRAPE_DISABLE_IMGS.
- To crawl pages with no restrictions use the --crawl-all flag, or filter which pages to crawl by URL keywords by passing one or more regexps to --crawl.
- If you want the crawler to follow links outside of the given URL's domain, use --nonstrict.
- Crawling can be stopped by Ctrl-C or alternatively by setting the number of pages or links to be crawled using --maxpages and --maxlinks. A page may contain zero or many links to more pages.
- The text output of scraped files can be printed to stdout rather than saved by entering --print.
- Filtering HTML can be done using --xpath, while filtering text is done by entering one or more regexps to --filter.
- If you only want to specify specific tag attributes to extract rather than an entire XPath, use --attributes. The default choice is to extract only text attributes, but you can specify one or many different attributes (such as href, src, title, or any attribute available..).
- Multiple files/URL's are saved to multiple output files/directories by default. To consolidate them, use the --single flag.