| Name | fort-health-tap-healthie JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | `tap-healthie` is a Singer tap for Healthie, built with the Meltano Singer SDK. |
| upload_time | 2023-05-25 02:49:04 |
| maintainer | |
| docs_url | None |
| author | Kevin Kong |
| requires_python | >=3.7.1,<3.12 |
| license | Apache 2.0 |
| keywords |
elt
healthie
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-healthie
`tap-healthie` is a Singer tap for Healthie.
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-healthie
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/tap-healthie.git@main
```
-->
## Configuration
### Accepted Config Options
<!--
Developer TODO: Provide a list of config options accepted by the tap.
This section can be created by copy-pasting the CLI output from:
```
tap-healthie --about --format=markdown
```
-->
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| environment | False | None | The name of the environment, 'Sandbox' or 'Production' |
| sandbox_api_key | False | None | The Sandbox API Key for authenticating to Healthie's API service |
| production_api_key | False | None | The Production API Key for authenticating to Healthie's API service |
| start_date | False | None | The earliest record date to sync |
| 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 is available by running: `tap-healthie --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
<!--
Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.
-->
## Usage
You can easily run `tap-healthie` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-healthie --version
tap-healthie --help
tap-healthie --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-healthie` CLI interface directly using `poetry run`:
```bash
poetry run tap-healthie --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-healthie
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-healthie --version
# OR run a test `elt` pipeline:
meltano elt tap-healthie 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": "fort-health-tap-healthie",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,Healthie",
"author": "Kevin Kong",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/da/46/c4dfce984d31e6da37f73df24d3359b283e1c3b6b952fb6b48fd6b5b60aa/fort_health_tap_healthie-0.0.1.tar.gz",
"platform": null,
"description": "# tap-healthie\n\n`tap-healthie` is a Singer tap for Healthie.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\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-healthie\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/tap-healthie.git@main\n```\n\n-->\n\n## Configuration\n\n### Accepted Config Options\n\n<!--\nDeveloper TODO: Provide a list of config options accepted by the tap.\n\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntap-healthie --about --format=markdown\n```\n-->\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| environment | False | None | The name of the environment, 'Sandbox' or 'Production' |\n| sandbox_api_key | False | None | The Sandbox API Key for authenticating to Healthie's API service |\n| production_api_key | False | None | The Production API Key for authenticating to Healthie's API service |\n| start_date | False | None | The earliest record date to sync |\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 is available by running: `tap-healthie --about`\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\n<!--\nDeveloper TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.\n-->\n\n## Usage\n\nYou can easily run `tap-healthie` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-healthie --version\ntap-healthie --help\ntap-healthie --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-healthie` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-healthie --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-healthie\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-healthie --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-healthie 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-healthie` is a Singer tap for Healthie, built with the Meltano Singer SDK.",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"elt",
"healthie"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e93fc567235f39548c1e3b99b3ee03f553faa3b46ff19696f9f12265a4da017f",
"md5": "85e1af32548e558c20d049ea2bc20fbc",
"sha256": "51c4eefef4d8c67457042e9c99e2ca9f1f270f8d68c19eb1ae7985bd2ceb1869"
},
"downloads": -1,
"filename": "fort_health_tap_healthie-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85e1af32548e558c20d049ea2bc20fbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 9040,
"upload_time": "2023-05-25T02:49:03",
"upload_time_iso_8601": "2023-05-25T02:49:03.248881Z",
"url": "https://files.pythonhosted.org/packages/e9/3f/c567235f39548c1e3b99b3ee03f553faa3b46ff19696f9f12265a4da017f/fort_health_tap_healthie-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da46c4dfce984d31e6da37f73df24d3359b283e1c3b6b952fb6b48fd6b5b60aa",
"md5": "c7c5ae4e03602266c2de51a921cf14e5",
"sha256": "e5d1636bc871cf9d580a27bcaec3e37d097828a8526e75f0603f3786efce3b78"
},
"downloads": -1,
"filename": "fort_health_tap_healthie-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c7c5ae4e03602266c2de51a921cf14e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 8939,
"upload_time": "2023-05-25T02:49:04",
"upload_time_iso_8601": "2023-05-25T02:49:04.460253Z",
"url": "https://files.pythonhosted.org/packages/da/46/c4dfce984d31e6da37f73df24d3359b283e1c3b6b952fb6b48fd6b5b60aa/fort_health_tap_healthie-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 02:49:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fort-health-tap-healthie"
}
