1
0
mirror of synced 2025-12-21 02:51:29 -05:00
Files
airbyte/airbyte-integrations/connectors/source-sparkpost/README.md
2024-10-22 20:40:28 -03:00

34 lines
1.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# SparkPost
This directory contains the manifest-only connector for `source-sparkpost`.
The SparkPost connector for Airbyte enables seamless integration with SparkPosts email delivery service, allowing users to automatically sync email performance data, including delivery, open, and click metrics, into their data warehouses.
## Usage
There are multiple ways to use this connector:
- You can use this connector as any other connector in Airbyte Marketplace.
- You can load this connector in `pyairbyte` using `get_source`!
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
Please refer to the manifest-only connector documentation for more details.
## Local Development
We recommend you use the Connector Builder to edit this connector.
But, if you want to develop this connector locally, you can use the following steps.
### Environment Setup
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).
### Build
This will create a dev image (`source-sparkpost:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-sparkpost build
```
### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-sparkpost test
```