| Name | tap-krow JSON |
| Version |
0.10.3
JSON |
| download |
| home_page | |
| Summary | `tap-krow` is a Singer tap for the KROW API, built with the Meltano SDK for Singer Taps. |
| upload_time | 2023-08-30 19:48:19 |
| maintainer | |
| docs_url | None |
| author | Datateer |
| requires_python | >=3.7.1,<3.12 |
| license | Apache 2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-krow
`tap-krow` is a Singer tap for the KROW API.
Built with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps.
Entity relationship diagram is available at https://dbdiagram.io/d/60b954d1b29a09603d17e3b3
## Installation
```bash
pipx install tap-krow
```
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-krow --about
```
api_key
: The KROW API key. This value is used to authenticate with the API by passing it to the header `Authentication: Bearer <api_key>`
api_url_base
: The KROW API base URL. Defaults to https://industry-staging.herokuapp.com/v1
### Source Authentication and Authorization
You can get an API key by contacting KROW
## Usage
You can easily run `tap-krow` by itself or in a pipeline using [Meltano](www.meltano.com).
### Executing the Tap Directly
```bash
tap-krow --version
tap-krow --help
tap-krow --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_krow/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-krow` CLI interface directly using `poetry run`:
```bash
poetry run tap-krow --help
```
### Manual test run
Create a config file that contains a `api_key` property, then run
```bash
poetry run tap-krow --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-krow/]().
### 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-krow
meltano install
```
Create a file `.env` with the contents:
```
export TAP_KROW_API_KEY=<api_key value here>
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-krow --version
# OR run a test `elt` pipeline:
meltano elt tap-krow 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-krow",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Datateer",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/4d/b2/8e93ac30a0aecbb058fb4b86961b4d7946d3ab73f5426646d0035ae19553/tap_krow-0.10.3.tar.gz",
"platform": null,
"description": "# tap-krow\n\n`tap-krow` is a Singer tap for the KROW API.\n\nBuilt with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps.\n\nEntity relationship diagram is available at https://dbdiagram.io/d/60b954d1b29a09603d17e3b3\n\n## Installation\n\n```bash\npipx install tap-krow\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-krow --about\n```\n\napi_key\n: The KROW API key. This value is used to authenticate with the API by passing it to the header `Authentication: Bearer <api_key>`\napi_url_base\n: The KROW API base URL. Defaults to https://industry-staging.herokuapp.com/v1\n\n### Source Authentication and Authorization\n\nYou can get an API key by contacting KROW\n\n## Usage\n\nYou can easily run `tap-krow` by itself or in a pipeline using [Meltano](www.meltano.com).\n\n### Executing the Tap Directly\n\n```bash\ntap-krow --version\ntap-krow --help\ntap-krow --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_krow/tests` subfolder and\nthen run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-krow` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-krow --help\n```\n\n### Manual test run\n\nCreate a config file that contains a `api_key` property, then run\n\n```bash\npoetry run tap-krow --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-krow/]().\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-krow\nmeltano install\n```\n\nCreate a file `.env` with the contents:\n\n```\nexport TAP_KROW_API_KEY=<api_key value here>\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-krow --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-krow 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-krow` is a Singer tap for the KROW API, built with the Meltano SDK for Singer Taps.",
"version": "0.10.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4d5c1203876ada3452965804156b797858c5ea7346e76c468eb328d9c0a5e7d",
"md5": "8ad7e3d4f9651c26e6adcc0ffe437b61",
"sha256": "fa3f85df211826f915458911f63edabaea9cf761cd3bbef398d9e6a25f04e81e"
},
"downloads": -1,
"filename": "tap_krow-0.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ad7e3d4f9651c26e6adcc0ffe437b61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 30855,
"upload_time": "2023-08-30T19:48:18",
"upload_time_iso_8601": "2023-08-30T19:48:18.249466Z",
"url": "https://files.pythonhosted.org/packages/d4/d5/c1203876ada3452965804156b797858c5ea7346e76c468eb328d9c0a5e7d/tap_krow-0.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4db28e93ac30a0aecbb058fb4b86961b4d7946d3ab73f5426646d0035ae19553",
"md5": "b894a653a18601465e535a1c19225b44",
"sha256": "387b124415fc3a012712cd985a8dcd76e8ec48ca9cfcc7036f76ccc58c5e3af5"
},
"downloads": -1,
"filename": "tap_krow-0.10.3.tar.gz",
"has_sig": false,
"md5_digest": "b894a653a18601465e535a1c19225b44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 23176,
"upload_time": "2023-08-30T19:48:19",
"upload_time_iso_8601": "2023-08-30T19:48:19.667209Z",
"url": "https://files.pythonhosted.org/packages/4d/b2/8e93ac30a0aecbb058fb4b86961b4d7946d3ab73f5426646d0035ae19553/tap_krow-0.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 19:48:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-krow"
}
