@ -15,7 +15,14 @@ You can also get it running with two commands:
sudo docker pull hrbrmstr/splashttpd
sudo docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 hrbrmstr/splashttpd
(Do whatever you Windows ppl do with Docker on your systems to make ^^ work.)
Do whatever you Windows ppl do with Docker on your systems to make ^^ work.
Folks super-new to Docker on Unix-ish platforms should [make sure to do](https://github.com/hrbrmstr/splashr/issues/3#issuecomment-280686494):
sudo groupadd docker
sudo usermod -aG docker $USER
(`$USER` is your username and shld be defined for you in the environment)
If using the [`harbor`](https://github.com/wch/harbor) package you can use the convience wrappers in this pacakge:
@ -26,7 +33,7 @@ and then run:
stop_splash(splash_container)
when done. All of that happens on your localhost so use `localhost` as the Splash server parameter.
when done. All of that happens on your localhost and you will not need to specify `splash_obj` to many of the `splashr` functions if you're running Splash in this default configuration as long as you use named parameters. You can also use the pre-defined `splash_local` object if you want to use positional parameters.
You can run Selenium in Docker, so this is not unique to Splash. But, a Docker context makes it so that you don't have to run or maintain icky Python stuff directly on your system. Leave it in the abandoned warehouse district where it belongs.
@ -111,6 +118,8 @@ options(width=120)
### Usage
NOTE: ALL of these examples assume Splash is running in the default configuraiton on `localhost` (i.e. started with `start_splash()` or the docker example commands) unless otherwise noted.
```{r message=FALSE, warning=FALSE, error=FALSE}
library(splashr)
library(magick)
@ -124,27 +133,23 @@ library(tidyverse)
# current verison
packageVersion("splashr")
splash("splash", 8050L) %>%
splash_active()
splash_active()
splash("splash", 8050L) %>%
splash_debug()
splash_debug()
```
Notice the difference between a rendered HTML scrape and a non-rendered one:
@ -12,7 +12,14 @@ You can also get it running with two commands:
sudo docker pull hrbrmstr/splashttpd
sudo docker run -p 5023:5023 -p 8050:8050 -p 8051:8051 hrbrmstr/splashttpd
(Do whatever you Windows ppl do with Docker on your systems to make ^^ work.)
Do whatever you Windows ppl do with Docker on your systems to make ^^ work.
Folks super-new to Docker on Unix-ish platforms should [make sure to do](https://github.com/hrbrmstr/splashr/issues/3#issuecomment-280686494):
sudo groupadd docker
sudo usermod -aG docker $USER
(`$USER` is your username and shld be defined for you in the environment)
If using the [`harbor`](https://github.com/wch/harbor) package you can use the convience wrappers in this pacakge:
@ -23,7 +30,7 @@ and then run:
stop_splash(splash_container)
when done. All of that happens on your localhost so use `localhost` as the Splash server parameter.
when done. All of that happens on your localhost and you will not need to specify `splash_obj` to many of the `splashr` functions if you're running Splash in this default configuration as long as you use named parameters. You can also use the pre-defined `splash_local` object if you want to use positional parameters.
You can run Selenium in Docker, so this is not unique to Splash. But, a Docker context makes it so that you don't have to run or maintain icky Python stuff directly on your system. Leave it in the abandoned warehouse district where it belongs.
@ -31,7 +38,7 @@ All you need for this package to work is a running Splash instance. You provide
### About Splash
> 'Splash' <https://github.com/scrapinghub/splash> is a javascript rendering service. It’s a lightweight web browser with an 'HTTP' API, implemented in Python using 'Twisted'and 'QT' [and provides some of the core functionality of the 'RSelenium' or 'seleniumPipes' R packages but with a Java-free footprint]. The (twisted) 'QT' reactor is used to make the sever fully asynchronous allowing to take advantage of 'webkit' concurrency via QT main loop. Some of Splash features include the ability to process multiple webpages in parallel; retrieving HTML results and/or take screenshots; disabling images or use Adblock Plus rules to make rendering faster; executing custom JavaScript in page context; getting detailed rendering info in HAR format.
> 'Splash' <https://github.com/scrapinghub/splash> is a javascript rendering service. It’s a lightweight web browser with an 'HTTP' API, implemented in Python using 'Twisted'and 'QT' \[and provides some of the core functionality of the 'RSelenium' or 'seleniumPipes' R packages but with a Java-free footprint\]. The (twisted) 'QT' reactor is used to make the sever fully asynchronous allowing to take advantage of 'webkit' concurrency via QT main loop. Some of Splash features include the ability to process multiple webpages in parallel; retrieving HTML results and/or take screenshots; disabling images or use Adblock Plus rules to make rendering faster; executing custom JavaScript in page context; getting detailed rendering info in HAR format.
The following functions are implemented:
@ -48,40 +55,40 @@ The following functions are implemented:
Mini-DSL (domain-specific language). These can be used to create a "script" without actually scripting in Lua. They are a less-powerful/configurable set of calls than what you can make with a full Lua function but the idea is to have it take care of very common but simple use-cases, like waiting a period of time before capturing a HAR/HTML/PNG image of a site:
- `splash_plugins`:Enable or disable browser plugins (e.g. Flash).
- `splash_images`:Enable/disable images
- `splash_response_body`:Enable or disable response content tracking.
- `splash_go`:Go to an URL.
- `splash_wait`:Wait for a period time
- `splash_har`:Return information about Splash interaction with a website in HAR format.
- `splash_html`:Return a HTML snapshot of a current page.
- `splash_png`:Return a screenshot of a current page in PNG format.
- `splash_user_agent:Overwrite the User-Agent header for all further requests. NOTE: There are many "helper" user agent strings to go with`splash_user_agent`. Look for objects in`splashr`starting with`ua_`.
- `splash_plugins`:Enable or disable browser plugins (e.g. Flash).
- `splash_images`:Enable/disable images
- `splash_response_body`:Enable or disable response content tracking.
- `splash_go`:Go to an URL.
- `splash_wait`:Wait for a period time
- `splash_har`:Return information about Splash interaction with a website in HAR format.
- `splash_html`:Return a HTML snapshot of a current page.
- `splash_png`:Return a screenshot of a current page in PNG format.
- `splash_user_agent:Overwrite the User-Agent header for all further requests. NOTE: There are many "helper" user agent strings to go with`splash\_user\_agent`. Look for objects in`splashr`starting with`ua\_\`.
`httr` helpers. These help turn various bits of `splashr` objects into `httr`-ish things:
- `as_req`: Turn a HAR response entry into a working `httr` function you can use to make a request with
- `as_request`: Turn a HAR response entry into an `httr``response`-like object (i.e. you can use `httr::content()` on it)
- `as_req`: Turn a HAR response entry into a working `httr` function you can use to make a request with
- `as_request`: Turn a HAR response entry into an `httr``response`-like object (i.e. you can use `httr::content()` on it)
Helpers:
- `get_body_size`:Retrieve size of content | body | headers
- `get_content_sie`:Retrieve size of content | body | headers
- `get_content_type`Retrieve or test content type of a HAR request object
- `get_headers_size`Retrieve size of content | body | headers
- `is_binary`:Retrieve or test content type of a HAR request object
- `is_content_type`:Retrieve or test content type of a HAR request object
- `is_css`:Retrieve or test content type of a HAR request object
- `is_gif`:Retrieve or test content type of a HAR request object
- `is_html`:Retrieve or test content type of a HAR request object
- `is_javascript`:Retrieve or test content type of a HAR request object
- `is_jpeg`:Retrieve or test content type of a HAR request object
- `is_json`:Retrieve or test content type of a HAR request object
- `is_plain`:Retrieve or test content type of a HAR request object
- `is_png`:Retrieve or test content type of a HAR request object
- `is_svg`:Retrieve or test content type of a HAR request object
- `get_body_size`:Retrieve size of content | body | headers
- `get_content_sie`:Retrieve size of content | body | headers
- `get_content_type`Retrieve or test content type of a HAR request object
- `get_headers_size`Retrieve size of content | body | headers
- `is_binary`:Retrieve or test content type of a HAR request object
- `is_content_type`:Retrieve or test content type of a HAR request object
- `is_css`:Retrieve or test content type of a HAR request object
- `is_gif`:Retrieve or test content type of a HAR request object
- `is_html`:Retrieve or test content type of a HAR request object
- `is_javascript`:Retrieve or test content type of a HAR request object
- `is_jpeg`:Retrieve or test content type of a HAR request object
- `is_json`:Retrieve or test content type of a HAR request object
- `is_plain`:Retrieve or test content type of a HAR request object
- `is_png`:Retrieve or test content type of a HAR request object
- `is_svg`:Retrieve or test content type of a HAR request object
- `is_xhr`: Retrieve or test content type of a HAR request object
- `is_xml`:Retrieve or test content type of a HAR request object
- `is_xml`:Retrieve or test content type of a HAR request object
Some functions from `HARtools` are imported/exported and `%>%` is imported/exported.
@ -108,6 +115,8 @@ options(width=120)
### Usage
NOTE: ALL of these examples assume Splash is running in the default configuraiton on `localhost` (i.e. started with `start_splash()` or the docker example commands) unless otherwise noted.
You can use [`HARtools::HARviewer`](https://github.com/johndharrison/HARtools/blob/master/R/HARviewer.R) — which this pkg import/exports — to get view the HAR in an interactive HTML widget.