| Name | tap-applehealth JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | `tap-applehealth` is a Singer tap for Apple Health, built with the Meltano Singer SDK. |
| upload_time | 2023-08-21 01:52:36 |
| maintainer | |
| docs_url | None |
| author | Felippe F. Caso |
| requires_python | >=3.7.1,<3.12 |
| license | Apache-2.0 |
| keywords |
elt
applehealth
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-applehealth
Singer tap for the `export.xml` file from Apple Health. Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Supported Data
- [x] Workout
- [ ] Record
- [ ] ActivitySummary
## Installation
Install from PyPi:
```bash
pipx install tap-applehealth
```
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| file_path | True | None | The file path of the export.xml file. It can be a local file or a `s3://` path. |
| 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. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-applehealth --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.
## Supported Python Versions
* 3.8
* 3.9
* 3.10
* 3.11
## Usage
You can easily run `tap-applehealth` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-applehealth --version
tap-applehealth --help
tap-applehealth --config CONFIG --discover > ./catalog.json
```
## Developer Resources
Follow these instructions to contribute to this project.
### Initialize your Development Environment
You will need [Poetry](https://python-poetry.org/docs/#installation) installed on your machine.
```bash
# Install package dependencies
poetry install
```
### Use pre-commit
```bash
pre-commit run --all-files
```
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
poetry run pytest
```
You can also test the `tap-applehealth` CLI interface directly using `poetry run`:
```bash
poetry run tap-applehealth --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._
Install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-applehealth
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-applehealth --version
# OR run a test `elt` pipeline:
meltano elt tap-applehealth 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-applehealth",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,AppleHealth",
"author": "Felippe F. Caso",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c4/4d/b7ad81df5359fa5875d1af77ffa7ba6fcd43ce7271770125d6f80ca0fa4a/tap_applehealth-0.0.4.tar.gz",
"platform": null,
"description": "# tap-applehealth\n\nSinger tap for the `export.xml` file from Apple Health. Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n## Supported Data\n\n- [x] Workout\n- [ ] Record\n- [ ] ActivitySummary\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-applehealth\n```\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n* `batch`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| file_path | True | None | The file path of the export.xml file. It can be a local file or a `s3://` path. |\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| batch_config | False | None | |\n\nA full list of supported settings and capabilities is available by running: `tap-applehealth --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## Supported Python Versions\n\n* 3.8\n* 3.9\n* 3.10\n* 3.11\n\n## Usage\n\nYou can easily run `tap-applehealth` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-applehealth --version\ntap-applehealth --help\ntap-applehealth --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\nYou will need [Poetry](https://python-poetry.org/docs/#installation) installed on your machine.\n\n```bash\n# Install package dependencies\npoetry install\n```\n\n### Use pre-commit\n\n```bash\npre-commit run --all-files\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-applehealth` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-applehealth --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\nInstall 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-applehealth\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-applehealth --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-applehealth 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-applehealth` is a Singer tap for Apple Health, built with the Meltano Singer SDK.",
"version": "0.0.4",
"project_urls": null,
"split_keywords": [
"elt",
"applehealth"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c96407a49ef8b1226c84f2b87084e9f8385123b0e11b5ec5450834d4ffbb8e9",
"md5": "d74393111e47f4d9046b4b0bb7859bc5",
"sha256": "f577f48192c4c6a51c2890f625a31896b5926386d624ba13731dcb9b489a57cc"
},
"downloads": -1,
"filename": "tap_applehealth-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d74393111e47f4d9046b4b0bb7859bc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 9832,
"upload_time": "2023-08-21T01:52:35",
"upload_time_iso_8601": "2023-08-21T01:52:35.073198Z",
"url": "https://files.pythonhosted.org/packages/8c/96/407a49ef8b1226c84f2b87084e9f8385123b0e11b5ec5450834d4ffbb8e9/tap_applehealth-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c44db7ad81df5359fa5875d1af77ffa7ba6fcd43ce7271770125d6f80ca0fa4a",
"md5": "a122f863900e9b1153f8d23752b3e73e",
"sha256": "58abd0ac029a0bec2bcf58fa8e98ca652282825e2f78453b33de22113be30add"
},
"downloads": -1,
"filename": "tap_applehealth-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "a122f863900e9b1153f8d23752b3e73e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 8402,
"upload_time": "2023-08-21T01:52:36",
"upload_time_iso_8601": "2023-08-21T01:52:36.485372Z",
"url": "https://files.pythonhosted.org/packages/c4/4d/b7ad81df5359fa5875d1af77ffa7ba6fcd43ce7271770125d6f80ca0fa4a/tap_applehealth-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 01:52:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-applehealth"
}
