tap-hubspot

HubSpot tap class.

Built with the Meltano Singer SDK.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening
• batch

Settings

Setting	Required	Default	Description
hapikey	True	None	HubSpot private app token
start_from	False	None	Starts incremental stream from this updated timestamp
no_search	False	0	Set to True to avoid using the search API - implies full table replication
batch_size	False	1000000	Size of batch files
batch_config	False	None
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
flattening_enabled	False	None	'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth	False	None	The max depth to flatten schemas.

A full list of supported settings and capabilities is available by running: tap-hubspot --about

Installation

pipx install https://github.com/spacecowboy/tap-hubspot.git

Usage

You can easily run tap-hubspot by itself or in a pipeline using Meltano.

Recommended batch size

In case you are using the batching feature please note that batches will never exceed 10 000 records. This is due to the HubSpot API which limits queries to 10 000 results. So to avoid issues downstream, each time that limit is reached a batch is forced to end.

Executing the Tap Directly

tap-hubspot --version
tap-hubspot --help
tap-hubspot --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_hubspot/tests subfolder and then run:

poetry run pytest

You can also test the tap-hubspot CLI interface directly using poetry run:

poetry run tap-hubspot --help

Running lint

poetry run tox -e lint

Format your code

poetry run tox -e format

Updating readme if you change config

poetry run tap-hubspot --about --format=markdown

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-hubspot
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-hubspot --version
# OR run a test `elt` pipeline:
meltano elt tap-hubspot target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.