The tap-beautifulsoup extractor pulls data from BeautifulSoup that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-beautifulsoup extractor to your
project using
:meltano add -
Configure the tap-beautifulsoup
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-beautifulsoupmeltano config tap-beautifulsoup set --interactivemeltano config tap-beautifulsoup testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-beautifulsoup
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-beautifulsoup settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-beautifulsoup list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Download Recursively (download_recursively)
-
Environment variable:
TAP_BEAUTIFULSOUP_DOWNLOAD_RECURSIVELY -
Default Value:
true
Attempt to download all pages recursively into the output directory prior to parsing files. Set this to False if you've previously run wget -r -A. Html https://sdk.meltano.com/en/latest/
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set download_recursively [value]Find All Kwargs (find_all_kwargs)
-
Environment variable:
TAP_BEAUTIFULSOUP_FIND_ALL_KWARGS
This dict contains all the kwargs that should be passed to the find_all call in order to extract text from the pages.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set find_all_kwargs [value]Output Folder (output_folder)
-
Environment variable:
TAP_BEAUTIFULSOUP_OUTPUT_FOLDER -
Default Value:
output
The file path of where to write the intermediate downloaded HTML files to.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set output_folder [value]Parser (parser)
-
Environment variable:
TAP_BEAUTIFULSOUP_PARSER -
Default Value:
html.parser
The BeautifulSoup parser to use.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set parser [value]Site URL (site_url)
-
Environment variable:
TAP_BEAUTIFULSOUP_SITE_URL
The site you'd like to scrape. The tap will download all pages recursively into the output directory prior to parsing files.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set site_url [value]Source Name (source_name)
-
Environment variable:
TAP_BEAUTIFULSOUP_SOURCE_NAME
The name of the source you're scraping. This will be used as the stream name.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set source_name [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_BEAUTIFULSOUP_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_BEAUTIFULSOUP_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_BEAUTIFULSOUP_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_BEAUTIFULSOUP_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-beautifulsoup set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
-40-c0c0c4){kind=icon}
-3-c0c0c4){kind=icon}
