| Name | tap-getresponse JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | |
| Summary | `tap-getresponse` is a Singer tap for GetResponse, built with the Meltano Singer SDK. |
| upload_time | 2023-08-25 11:57:24 |
| maintainer | |
| docs_url | None |
| author | Leo Grosjean |
| requires_python | >=3.7.1,<3.12 |
| license | Apache-2.0 |
| keywords |
elt
getresponse
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <h1 align="center">Tap-GetResponse</h1>
`tap-getresponse` is a Singer tap for GetResponse.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
<!--
Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
## Installation
Install from PyPi:
```bash
pipx install tap-getresponse
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/tap-getresponse.git@main
```
-->
## 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/).
### Executing the Tap Directly
```bash
tap-getresponse --version
tap-getresponse --help
tap-getresponse --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-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._
<!--
Developer TODO:
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-getresponse
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-getresponse --version
# OR run a test `elt` pipeline:
meltano elt tap-getresponse 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": "",
"name": "tap-getresponse",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,GetResponse",
"author": "Leo Grosjean",
"author_email": "leo.bigjin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ab/46/2c8778f149647176c86038aef4c78c67f6a5c4f01506ac60d211d7e281c1/tap_getresponse-0.0.2.tar.gz",
"platform": null,
"description": "# <h1 align=\"center\">Tap-GetResponse</h1>\n\n\n`tap-getresponse` is a Singer tap for GetResponse.\n\n\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n\n<!--\n\nDeveloper TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-getresponse\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/tap-getresponse.git@main\n```\n\n-->\n\n## Configuration \ud83d\udcdd\n\n### Accepted Config Options\n\n\n| Setting | Required | Default | Description |\n| :--------- | :------: | :-----: | :--------------------- |\n| auth_token | True | None | GetResponse token API. |\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\n```\n# .env\nTAP_GETRESPONSE_AUTH_TOKEN=... # your token!\n```\n\n### Source Authentication and Authorization\n\nTo get your API Token, follow the [official documentation](https://apidocs.getresponse.com/v3/authentication).\n\n## Usage\n\nYou can easily run `tap-getresponse` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-getresponse --version\ntap-getresponse --help\ntap-getresponse --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-getresponse` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-getresponse --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\n<!--\nDeveloper TODO:\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-->\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-getresponse\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-getresponse --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-getresponse 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",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "`tap-getresponse` is a Singer tap for GetResponse, built with the Meltano Singer SDK.",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"elt",
"getresponse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e05e2e8e1fdd0678941c47808bf544d96c167bfa097493cbbd5a031030762de9",
"md5": "74fe1daa2a30d126b45ee5cd545f6496",
"sha256": "a9db7fd70b867a98818309ecff54f2b772c0f3f6157e2d8e541a6ee766b84ab1"
},
"downloads": -1,
"filename": "tap_getresponse-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74fe1daa2a30d126b45ee5cd545f6496",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 13190,
"upload_time": "2023-08-25T11:57:22",
"upload_time_iso_8601": "2023-08-25T11:57:22.831886Z",
"url": "https://files.pythonhosted.org/packages/e0/5e/2e8e1fdd0678941c47808bf544d96c167bfa097493cbbd5a031030762de9/tap_getresponse-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab462c8778f149647176c86038aef4c78c67f6a5c4f01506ac60d211d7e281c1",
"md5": "9c20e52260665084ebdfc7427fd7b415",
"sha256": "970ca3f54cbf531b084d463c46762b18c108a2862e011ba594fa38dd9d8404c5"
},
"downloads": -1,
"filename": "tap_getresponse-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9c20e52260665084ebdfc7427fd7b415",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 12311,
"upload_time": "2023-08-25T11:57:24",
"upload_time_iso_8601": "2023-08-25T11:57:24.291926Z",
"url": "https://files.pythonhosted.org/packages/ab/46/2c8778f149647176c86038aef4c78c67f6a5c4f01506ac60d211d7e281c1/tap_getresponse-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-25 11:57:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-getresponse"
}
