<h1 align="center">Tap-Qualified</h1>
<p align="center">
<a href="https://github.com/z3z1ma/tap-qualified/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
`tap-qualified` is a Singer tap for [Qualified](https://www.qualified.com/).
Qualified helps companies generate pipeline, faster. Tap into your greatest asset - your website - to identify your most valuable visitors, instantly start sales conversations, schedule meetings, convert outbound and paid traffic, and uncover signals of buying intent.
Install from [PyPi](https://pypi.org/project/tap-qualified/):
```bash
pipx install tap-qualified
```
## Configuration
### Accepted Config Options
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| api_key | True | None | The token to authenticate against the API service |
| user_agent | False | Harness.io/Tap Qualified | The user agent to use when making requests to the API service |
| 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. |
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-qualified --about
```
### 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
Reach out to your account executive to inquire about API access.
## Usage
You can easily run `tap-qualified` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-qualified --version
tap-qualified --help
tap-qualified --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 `tap_qualified/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-qualified` CLI interface directly using `poetry run`:
```bash
poetry run tap-qualified --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-qualified
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-qualified --version
# OR run a test `elt` pipeline:
meltano elt tap-qualified 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.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
Raw data
{
"_id": null,
"home_page": "https://github.com/z3z1ma/tap-qualified",
"name": "tap-qualified",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "ELT,Qualified",
"author": "Alex Butler",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/93/22/4a5daa735169eeac7a2cdc6e02bba8201fa86a10d1389e4776aef9306531/tap_qualified-1.0.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Tap-Qualified</h1>\n\n<p align=\"center\">\n<a href=\"https://github.com/z3z1ma/tap-qualified/blob/main/LICENSE\"><img alt=\"License: MIT\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"></a>\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n</p>\n\n`tap-qualified` is a Singer tap for [Qualified](https://www.qualified.com/).\n\nQualified helps companies generate pipeline, faster. Tap into your greatest asset - your website - to identify your most valuable visitors, instantly start sales conversations, schedule meetings, convert outbound and paid traffic, and uncover signals of buying intent.\n\nInstall from [PyPi](https://pypi.org/project/tap-qualified/):\n\n```bash\npipx install tap-qualified\n```\n\n## Configuration\n\n### Accepted Config Options\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| api_key | True | None | The token to authenticate against the API service |\n| user_agent | False | Harness.io/Tap Qualified | The user agent to use when making requests to the API service |\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\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-qualified --about\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\nReach out to your account executive to inquire about API access.\n\n## Usage\n\nYou can easily run `tap-qualified` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-qualified --version\ntap-qualified --help\ntap-qualified --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 `tap_qualified/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-qualified` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-qualified --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\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-qualified\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-qualified --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-qualified 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\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "`tap-qualified` is a Singer tap for Qualified, built with the Meltano Singer SDK.",
"version": "1.0.1",
"split_keywords": [
"elt",
"qualified"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4672bcc9235456a6d97c0706cfbb220c24820a3c65d07f2bb9aac97151e39c04",
"md5": "d1bf4a515bc1d4fb7adc828802a4d18c",
"sha256": "4adb9809c2bf2d5cb834505f370a6db963bd33472fe0568ae71f7ef3ebc3f435"
},
"downloads": -1,
"filename": "tap_qualified-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1bf4a515bc1d4fb7adc828802a4d18c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 8526,
"upload_time": "2023-01-31T08:58:41",
"upload_time_iso_8601": "2023-01-31T08:58:41.024889Z",
"url": "https://files.pythonhosted.org/packages/46/72/bcc9235456a6d97c0706cfbb220c24820a3c65d07f2bb9aac97151e39c04/tap_qualified-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93224a5daa735169eeac7a2cdc6e02bba8201fa86a10d1389e4776aef9306531",
"md5": "9d3e7cbcc30a17f81a7b431838ea221b",
"sha256": "2aa3cabde2ba8004d2307611e2f7edb798c0f9556d49463b0388845a0f128830"
},
"downloads": -1,
"filename": "tap_qualified-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9d3e7cbcc30a17f81a7b431838ea221b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 8321,
"upload_time": "2023-01-31T08:58:43",
"upload_time_iso_8601": "2023-01-31T08:58:43.104224Z",
"url": "https://files.pythonhosted.org/packages/93/22/4a5daa735169eeac7a2cdc6e02bba8201fa86a10d1389e4776aef9306531/tap_qualified-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-31 08:58:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "z3z1ma",
"github_project": "tap-qualified",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "tap-qualified"
}
JSON
