| Name | tap-clickcast JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | |
| Summary | `tap-clickcast` is a Singer tap for clickcast, built with the Meltano SDK for Singer Taps. |
| upload_time | 2024-01-16 00:23:16 |
| maintainer | |
| docs_url | None |
| author | Datateer |
| requires_python | >=3.9,<3.11 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-clickcast
`tap-clickcast` is a Singer tap for AppCast's Clickcast API.
Built with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps. More information about Clickcast API can be found at https://api.clickcast.cloud/clickcast/home#/
## Installation
```bash
pipx install tap-clickcast
```
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-clickcast --about
```
partner_token
: The Clickcast API Partner Token. This value is used to authenticate with the API by passing it to the header `X-Partner-Token`
api_url_base
: The Clickcast API base URL. Defaults to https://api.clickcast.cloud/clickcast/api
### Source Authentication and Authorization
You can generate a Partner Token at https://api.clickcast.cloud/clickcast/home#/tokens
## Usage
You can easily run `tap-clickcast` by itself or in a pipeline using [Meltano](www.meltano.com).
### Executing the Tap Directly
```bash
tap-clickcast --version
tap-clickcast --help
tap-clickcast --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_clickcast/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-clickcast` CLI interface directly using `poetry run`:
```bash
poetry run tap-clickcast --help
```
### Manual test run
Create a config file that contains a `partner_token` property, then run
```bash
poetry run tap-clickcast --config config.json
```
### Release new version
Workflows in the `.github` will create a new version number using Semantic Release.
Any commit that starts with `feat: ...` will create a new minor version (and any comment that starts with `fix: ...` will create a new minor version) when the commit is finally merged to main after a PR is approved and merged.
Then the new version is published to PyPI, available at [https://pypi.org/project/tap-clickcast/]().
### 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-clickcast
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-clickcast --version
# OR run a test `elt` pipeline:
meltano elt tap-clickcast 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-clickcast",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.11",
"maintainer_email": "",
"keywords": "",
"author": "Datateer",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/1f/1b/732ecd064cfb3ca5e83b540107f535981c6ac373d12283ec24662a88d45e/tap_clickcast-0.6.0.tar.gz",
"platform": null,
"description": "# tap-clickcast\n\n`tap-clickcast` is a Singer tap for AppCast's Clickcast API.\n\nBuilt with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps. More information about Clickcast API can be found at https://api.clickcast.cloud/clickcast/home#/\n\n## Installation\n\n```bash\npipx install tap-clickcast\n```\n\n## Configuration\n\n### Accepted Config Options\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-clickcast --about\n```\n\npartner_token\n: The Clickcast API Partner Token. This value is used to authenticate with the API by passing it to the header `X-Partner-Token`\napi_url_base\n: The Clickcast API base URL. Defaults to https://api.clickcast.cloud/clickcast/api\n\n### Source Authentication and Authorization\n\nYou can generate a Partner Token at https://api.clickcast.cloud/clickcast/home#/tokens\n\n## Usage\n\nYou can easily run `tap-clickcast` by itself or in a pipeline using [Meltano](www.meltano.com).\n\n### Executing the Tap Directly\n\n```bash\ntap-clickcast --version\ntap-clickcast --help\ntap-clickcast --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\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_clickcast/tests` subfolder and\nthen run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-clickcast` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-clickcast --help\n```\n\n### Manual test run\n\nCreate a config file that contains a `partner_token` property, then run\n\n```bash\npoetry run tap-clickcast --config config.json\n```\n\n### Release new version\n\nWorkflows in the `.github` will create a new version number using Semantic Release.\n\nAny commit that starts with `feat: ...` will create a new minor version (and any comment that starts with `fix: ...` will create a new minor version) when the commit is finally merged to main after a PR is approved and merged.\n\nThen the new version is published to PyPI, available at [https://pypi.org/project/tap-clickcast/]().\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-clickcast\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-clickcast --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-clickcast 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-clickcast` is a Singer tap for clickcast, built with the Meltano SDK for Singer Taps.",
"version": "0.6.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5768b04ba5c3313ca4ce86e30d5d979b506ef58b6a0c618525d483bc2616e304",
"md5": "5093285c5e18b085a5976a57d099f114",
"sha256": "630575e2be99806a3fbd4bc720b33a82371fc05c9e474f2c1e721bf09d7a7ace"
},
"downloads": -1,
"filename": "tap_clickcast-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5093285c5e18b085a5976a57d099f114",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.11",
"size": 10732,
"upload_time": "2024-01-16T00:23:14",
"upload_time_iso_8601": "2024-01-16T00:23:14.975708Z",
"url": "https://files.pythonhosted.org/packages/57/68/b04ba5c3313ca4ce86e30d5d979b506ef58b6a0c618525d483bc2616e304/tap_clickcast-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f1b732ecd064cfb3ca5e83b540107f535981c6ac373d12283ec24662a88d45e",
"md5": "e33abd2dd339a833baa91b6e61cfbc3b",
"sha256": "48c9271f144dda7d1700ccdbfa85ab283330d8b36716bfee9f68c6c25f7c8f55"
},
"downloads": -1,
"filename": "tap_clickcast-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "e33abd2dd339a833baa91b6e61cfbc3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.11",
"size": 8571,
"upload_time": "2024-01-16T00:23:16",
"upload_time_iso_8601": "2024-01-16T00:23:16.427191Z",
"url": "https://files.pythonhosted.org/packages/1f/1b/732ecd064cfb3ca5e83b540107f535981c6ac373d12283ec24662a88d45e/tap_clickcast-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 00:23:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-clickcast"
}
