| Name | meltano-tap-hubspot JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | `tap-hubspot` is a Singer tap for tap-hubspot, built with the Meltano Singer SDK. |
| upload_time | 2024-12-10 23:12:24 |
| maintainer | None |
| docs_url | None |
| author | Ethan Stein |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
elt
tap-hubspot
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `tap-hubspot`
tap-hubspot is a Singer tap for Hubspot.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| access_token | False | None | Token to authenticate against the API service |
| client_id | False | None | The OAuth app client ID. |
| client_secret | False | None | The OAuth app client secret. |
| refresh_token | False | None | The OAuth app refresh token. |
| start_date | False | None | Earliest record date to sync |
| end_date | False | None | Latest record date to sync |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| 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. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-hubspot --about`
## Elastic License 2.0
The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.
## Installation
```bash
pipx install git+https://github.com/ryan-miranda-partners/tap-hubspot.git
```
### Configure using environment variables
This Singer tap will automatically import any environment variables within the working directory's
`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the `.env` file.
### Source Authentication and Authorization
A Hubspot access token is required to make API requests. (See [Hubspot API](https://developers.hubspot.com/docs/api/working-with-oauth) docs for more info)
### Permissions
The following scopes need to be added to your access token to access the following endpoints:
- Contacts: `crm.schemas.contacts.read` or `crm.objects.contacts.read`
- Users: `settings.users.read`
- Ticket Pipeline: `media_bridge.read` or `crm.schemas.custom.read` or `timeline` or `tickets` or `e-commerce` or `crm.objects.goals.read`
- Deal Pipeline: `media_bridge.read` or `crm.schemas.custom.read` or `timeline` or `tickets` or `e-commerce` or `crm.objects.goals.read`
- Properties: All of `Tickets`, `crm.objects.deals.read`, `sales-email-read`, `crm.objects.contacts.read`, `crm.objects.companies.read`, `e-commerce`, `crm.objects.quotes.read`
- Owners: `crm.objects.owners.read`
- Companies: `crm.objects.companies.read`
- Deals: `crm.objects.deals.read`
- Feedback Submissions: `crm.objects.contacts.read`
- Line Items: `e-commerce`
- Products: `e-commerce`
- Tickets: `tickets`
- Quotes: `crm.objects.quotes.read` or `crm.schemas.quotes.read`
- Goals: `crm.objects.goals.read`
- Emails: `sales-email-read`
For more info on the streams and permissions, check the [Hubspot API Documentation](https://developers.hubspot.com/docs/api/overview).
## Usage
You can easily run `tap-hubspot` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Streams Using v1 Endpoints
The following Streams use the v1 (legacy) endpoint in the Hubspot API:
1. [TicketPipeline & DealPipeline](https://legacydocs.hubspot.com/docs/methods/pipelines/pipelines_overview): The v3 endpoint requires a pipeline ID parameter to make calls to the API. Because of this,
you are limited to only pulling data for a single pipeline ID from v3, whereas the v1 API allows you to pull from all pipelines.
2. [EmailSubscriptions](https://legacydocs.hubspot.com/docs/methods/email/email_subscriptions_overview): The v3 endpoint requires you to set a single email address to pull subscription data, whereas
the v1 endpoint allows you to pull data from all emails.
## Stream Inheritance
This project uses parent-child streams. Learn more about them [here](https://gitlab.com/meltano/sdk/-/blob/main/docs/parent_streams.md).
### Executing the Tap Directly
```bash
tap-hubspot --version
tap-hubspot --help
tap-hubspot --config CONFIG --discover > ./catalog.json
```
## Developer Resources
Follow these instructions to contribute to this project.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-hubspot` CLI interface directly using `poetry run`:
```bash
poetry run tap-hubspot --help
```
### Testing with [Meltano](https://www.meltano.com)
_**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._
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-hubspot
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# 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](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": null,
"name": "meltano-tap-hubspot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ELT, tap-hubspot",
"author": "Ethan Stein",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/66/34/9ed82fc07a42eca96310b2ffe1d3373a4df431339fed91e3081f4338dc69/meltano_tap_hubspot-0.6.1.tar.gz",
"platform": null,
"description": "# `tap-hubspot`\n\ntap-hubspot is a Singer tap for Hubspot.\n\nBuilt with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n* `batch`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| access_token | False | None | Token to authenticate against the API service |\n| client_id | False | None | The OAuth app client ID. |\n| client_secret | False | None | The OAuth app client secret. |\n| refresh_token | False | None | The OAuth app refresh token. |\n| start_date | False | None | Earliest record date to sync |\n| end_date | False | None | Latest record date to sync |\n| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth| False | None | The max depth to flatten schemas. |\n| batch_config | False | None | |\n\nA full list of supported settings and capabilities is available by running: `tap-hubspot --about`\n\n## Elastic License 2.0\n\nThe licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.\n\n## Installation\n\n```bash\npipx install git+https://github.com/ryan-miranda-partners/tap-hubspot.git\n```\n\n### Configure using environment variables\n\nThis Singer tap will automatically import any environment variables within the working directory's\n`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching\nenvironment variable is set either in the terminal context or in the `.env` file.\n\n### Source Authentication and Authorization\n\nA Hubspot access token is required to make API requests. (See [Hubspot API](https://developers.hubspot.com/docs/api/working-with-oauth) docs for more info)\n\n\n### Permissions\n\nThe following scopes need to be added to your access token to access the following endpoints:\n\n- Contacts: `crm.schemas.contacts.read` or `crm.objects.contacts.read`\n- Users: `settings.users.read`\n- Ticket Pipeline: `media_bridge.read` or `crm.schemas.custom.read` or `timeline` or `tickets` or `e-commerce` or `crm.objects.goals.read`\n- Deal Pipeline: `media_bridge.read` or `crm.schemas.custom.read` or `timeline` or `tickets` or `e-commerce` or `crm.objects.goals.read`\n- Properties: All of `Tickets`, `crm.objects.deals.read`, `sales-email-read`, `crm.objects.contacts.read`, `crm.objects.companies.read`, `e-commerce`, `crm.objects.quotes.read`\n- Owners: `crm.objects.owners.read`\n- Companies: `crm.objects.companies.read`\n- Deals: `crm.objects.deals.read`\n- Feedback Submissions: `crm.objects.contacts.read`\n- Line Items: `e-commerce`\n- Products: `e-commerce`\n- Tickets: `tickets`\n- Quotes: `crm.objects.quotes.read` or `crm.schemas.quotes.read`\n- Goals: `crm.objects.goals.read`\n- Emails: `sales-email-read`\n\nFor more info on the streams and permissions, check the [Hubspot API Documentation](https://developers.hubspot.com/docs/api/overview).\n\n## Usage\n\nYou can easily run `tap-hubspot` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n\n### Streams Using v1 Endpoints\n\nThe following Streams use the v1 (legacy) endpoint in the Hubspot API:\n\n1. [TicketPipeline & DealPipeline](https://legacydocs.hubspot.com/docs/methods/pipelines/pipelines_overview): The v3 endpoint requires a pipeline ID parameter to make calls to the API. Because of this,\nyou are limited to only pulling data for a single pipeline ID from v3, whereas the v1 API allows you to pull from all pipelines.\n2. [EmailSubscriptions](https://legacydocs.hubspot.com/docs/methods/email/email_subscriptions_overview): The v3 endpoint requires you to set a single email address to pull subscription data, whereas\nthe v1 endpoint allows you to pull data from all emails.\n\n\n## Stream Inheritance\n\nThis project uses parent-child streams. Learn more about them [here](https://gitlab.com/meltano/sdk/-/blob/main/docs/parent_streams.md).\n\n### Executing the Tap Directly\n\n```bash\ntap-hubspot --version\ntap-hubspot --help\ntap-hubspot --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\nFollow these instructions to contribute to this project.\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-hubspot` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-hubspot --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nYour project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any \"TODO\" items listed in\nthe file.\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-hubspot\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-hubspot --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-hubspot target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "`tap-hubspot` is a Singer tap for tap-hubspot, built with the Meltano Singer SDK.",
"version": "0.6.1",
"project_urls": null,
"split_keywords": [
"elt",
" tap-hubspot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6790ccfd882b19d3b787efdde8d184c9d7f37896dffb2aa49b7004ed05802325",
"md5": "7d54cb0b3421c9b3d987d83839601928",
"sha256": "f59a7f7f2d69cfd306b815c91f2dbe572b602600e707a6b0a5070d894cda193b"
},
"downloads": -1,
"filename": "meltano_tap_hubspot-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d54cb0b3421c9b3d987d83839601928",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13808,
"upload_time": "2024-12-10T23:12:22",
"upload_time_iso_8601": "2024-12-10T23:12:22.479799Z",
"url": "https://files.pythonhosted.org/packages/67/90/ccfd882b19d3b787efdde8d184c9d7f37896dffb2aa49b7004ed05802325/meltano_tap_hubspot-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66349ed82fc07a42eca96310b2ffe1d3373a4df431339fed91e3081f4338dc69",
"md5": "fb91ae785af7d399a0aed353938b27b4",
"sha256": "be8a8681c7aef5c8ee710386754455d8157725b157220c49e5c424e50ea476d3"
},
"downloads": -1,
"filename": "meltano_tap_hubspot-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "fb91ae785af7d399a0aed353938b27b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14080,
"upload_time": "2024-12-10T23:12:24",
"upload_time_iso_8601": "2024-12-10T23:12:24.892578Z",
"url": "https://files.pythonhosted.org/packages/66/34/9ed82fc07a42eca96310b2ffe1d3373a4df431339fed91e3081f4338dc69/meltano_tap_hubspot-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 23:12:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "meltano-tap-hubspot"
}
