https://github.com/lgrosjean/tap-getresponse
a Meltano Tap for GetResponse Core
https://github.com/lgrosjean/tap-getresponse
getresponse-api meltano
Last synced: about 1 month ago
JSON representation
a Meltano Tap for GetResponse Core
- Host: GitHub
- URL: https://github.com/lgrosjean/tap-getresponse
- Owner: lgrosjean
- License: apache-2.0
- Created: 2023-08-24T07:35:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-17T13:57:18.000Z (over 2 years ago)
- Last Synced: 2023-11-18T14:55:16.410Z (over 2 years ago)
- Topics: getresponse-api, meltano
- Language: Python
- Homepage:
- Size: 252 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
Tap-GetResponse
`tap-getresponse` is a Singer tap for GetResponse.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Configuration 📝
### Accepted Config Options
| Setting | Required | Default | Description |
| :--------- | :------: | :-----: | :--------------------- |
| auth_token | True | None | GetResponse token API. |
### 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.
```
# .env
TAP_GETRESPONSE_AUTH_TOKEN=... # your token!
```
### Source Authentication and Authorization
To get your API Token, follow the [official documentation](https://apidocs.getresponse.com/v3/authentication).
## Usage
You can easily run `tap-getresponse` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Execute in a Meltano pipeline
#### Install the project
```bash
meltano install
```
#### Select Entities and Attributes to Extract
```bash
meltano select tap-getresponse
meltano select tap-getresponse --exclude
# For example:
meltano select tap-getresponse webinars "*"
```
Verify that only the intended entities and attributes are now selected using `meltano select --list`:
```bash
meltano select tap-getresponse --list
```
#### Run the pipeline
Run your newly added GetResponse extractor and chosen loader in a pipeline using `meltano run`:
```bash
meltano run tap-getresponse
# For example:
meltano run tap-getresponse target-jsonl
```
There is also the `meltano elt` (or `meltano el`) command which is a more rigid command for running only EL pipelines.
Or directly using the `meltano invoke`, which only executes a single plugin at a time. This can be useful for debugging the extractor (`meltano invoke tap-getresponse`).
```bash
# Test invocation:
meltano invoke tap-getresponse --version
# OR run a test `elt` pipeline:
meltano elt tap-getresponse
# Example
meltano elt tap-getresponse target-jsonl
```
## 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-getresponse` CLI interface directly using `poetry run`:
```bash
poetry run tap-getresponse --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._
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-getresponse
meltano install
```
### 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.