`tap-applehealth` is a Singer tap for Apple Health, built with the Meltano Singer SDK.
Project description
tap-applehealth
Singer tap for the export.xml
file from Apple Health. Built with the Meltano Tap SDK for Singer Taps.
Supported Data
- Workout
- Record
- ActivitySummary
Installation
Install from PyPi:
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. |
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.
Executing the Tap Directly
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 installed on your machine.
# Install package dependencies
poetry install
Use pre-commit
pre-commit run --all-files
Create and Run Tests
Create tests within the tests
subfolder and then run:
poetry run pytest
You can also test the tap-applehealth
CLI interface directly using poetry run
:
poetry run tap-applehealth --help
Testing with Meltano
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:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-applehealth
meltano install
Now you can test and orchestrate using Meltano:
# 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 for more instructions on how to use the SDK to develop your own taps and targets.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tap_applehealth-0.0.4.tar.gz
.
File metadata
- Download URL: tap_applehealth-0.0.4.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58abd0ac029a0bec2bcf58fa8e98ca652282825e2f78453b33de22113be30add |
|
MD5 | a122f863900e9b1153f8d23752b3e73e |
|
BLAKE2b-256 | c44db7ad81df5359fa5875d1af77ffa7ba6fcd43ce7271770125d6f80ca0fa4a |
File details
Details for the file tap_applehealth-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: tap_applehealth-0.0.4-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f577f48192c4c6a51c2890f625a31896b5926386d624ba13731dcb9b489a57cc |
|
MD5 | d74393111e47f4d9046b4b0bb7859bc5 |
|
BLAKE2b-256 | 8c96407a49ef8b1226c84f2b87084e9f8385123b0e11b5ec5450834d4ffbb8e9 |