| Name | target-apprise JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | None |
| Summary | `target-apprise` is a Singer target for Apprise, built with the Meltano SDK for Singer Targets. |
| upload_time | 2024-10-22 19:16:04 |
| maintainer | None |
| docs_url | None |
| author | AutoIDM |
| requires_python | <3.11,>=3.7.1 |
| license | Apache 2.0 |
| keywords |
elt
apprise
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `target-apprise`  [](https://pypi.python.org/pypi/target-apprise/)
Target for Apprise.
Tap was created by [AutoIDM](https://autoidm.com)
<a href="https://autoidm.com"><img alt="AutoIDM" src="./images/autoidm.png" width="250"></a>
Built with the [Meltano SDK](https://sdk.meltano.com) for Singer Taps and Targets. Curious about Meltano? I'd recommend checking out the [Meltano Hub](https://hub.meltano.com/) for a large number of taps/targets available to connect data with!
# Usage (example with a slack uri)
```bash
pipx install meltano
#Note that you have to escape the quotes, dotenv is nice as it's not committed along with your repo keeping your secrets, secret!
meltano config target-apprise set uris [\"https://hooks.slack.com/services/tokenhere/tokenhere/tokenhere\"] --store dotenv
meltano invoke target-apprise --version
# Note that instead of input_example, you can setup data to come from anywhere (Normally it'd be from a DB / DW via a singer tap)
cat input_example | meltano invoke target-apprise
```
# Sponsors
Want to become a sponsor? Reach out to us at [autoidm.com](https://autoidm.com)
## Capabilities
* `about`
* `stream-maps`
* `schema-flattening`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| uris | True | None | Array of apprise URIs, see list here https://github.com/caronc/apprise |
| stream_maps | False | None | Config object for stream maps capability. (Doesn't make much sense with this target) |
| stream_map_config | False | None | User-defined config values to be used within map expressions. (Doesn't make much sense with this target) |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. (Doesn't make much sense with this target) |
| flattening_max_depth| False | None | The max depth to flatten schemas. (Doesn't make much sense with this target) |
A full list of supported settings and capabilities is available by running: `target-apprise --about`
Note that uris are **sensitive** information, so be sure to set these in your `.env` file if you're using Meltano.
### Source Authentication and Authorization
## Usage
You can easily run `target-apprise` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Target Directly
```bash
target-apprise --version
target-apprise --help
# Test using the sample in this repo:
cat input_example | target-apprise --config /path/to/target-apprise-config.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `target_apprise/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `target-apprise` CLI interface directly using `poetry run`:
```bash
poetry run target-apprise --help
```
### Testing with [Meltano](https://meltano.com/)
_**Note:** This target will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd target-apprise
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke target-apprise --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
cat cat input_example | meltano invoke target-apprise
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the Meltano SDK to
develop your own Singer taps and targets.
Raw data
{
"_id": null,
"home_page": null,
"name": "target-apprise",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11,>=3.7.1",
"maintainer_email": null,
"keywords": "ELT, Apprise",
"author": "AutoIDM",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/88/69/14ddf4cbee69592f4d938ee83a284dd857bc07b055388e4aab96ec445b9b/target_apprise-0.0.7.tar.gz",
"platform": null,
"description": "# `target-apprise`  [](https://pypi.python.org/pypi/target-apprise/) \nTarget for Apprise. \n\nTap was created by [AutoIDM](https://autoidm.com)\n\n<a href=\"https://autoidm.com\"><img alt=\"AutoIDM\" src=\"./images/autoidm.png\" width=\"250\"></a>\n\nBuilt with the [Meltano SDK](https://sdk.meltano.com) for Singer Taps and Targets. Curious about Meltano? I'd recommend checking out the [Meltano Hub](https://hub.meltano.com/) for a large number of taps/targets available to connect data with!\n\n# Usage (example with a slack uri)\n\n```bash\npipx install meltano\n#Note that you have to escape the quotes, dotenv is nice as it's not committed along with your repo keeping your secrets, secret!\nmeltano config target-apprise set uris [\\\"https://hooks.slack.com/services/tokenhere/tokenhere/tokenhere\\\"] --store dotenv\nmeltano invoke target-apprise --version\n# Note that instead of input_example, you can setup data to come from anywhere (Normally it'd be from a DB / DW via a singer tap) \ncat input_example | meltano invoke target-apprise\n```\n\n# Sponsors\nWant to become a sponsor? Reach out to us at [autoidm.com](https://autoidm.com)\n\n## Capabilities\n\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| uris | True | None | Array of apprise URIs, see list here https://github.com/caronc/apprise |\n| stream_maps | False | None | Config object for stream maps capability. (Doesn't make much sense with this target) |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. (Doesn't make much sense with this target) |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. (Doesn't make much sense with this target) |\n| flattening_max_depth| False | None | The max depth to flatten schemas. (Doesn't make much sense with this target) |\n\nA full list of supported settings and capabilities is available by running: `target-apprise --about`\n\nNote that uris are **sensitive** information, so be sure to set these in your `.env` file if you're using Meltano. \n\n\n### Source Authentication and Authorization\n\n\n## Usage\n\nYou can easily run `target-apprise` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Target Directly\n\n```bash\ntarget-apprise --version\ntarget-apprise --help\n# Test using the sample in this repo:\ncat input_example | target-apprise --config /path/to/target-apprise-config.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 `target_apprise/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `target-apprise` CLI interface directly using `poetry run`:\n\n```bash\npoetry run target-apprise --help\n```\n\n### Testing with [Meltano](https://meltano.com/)\n\n_**Note:** This target 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\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 target-apprise\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke target-apprise --version\n# OR run a test `elt` pipeline with the Carbon Intensity sample tap:\ncat cat input_example | meltano invoke target-apprise\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 Meltano SDK to\ndevelop your own Singer taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "`target-apprise` is a Singer target for Apprise, built with the Meltano SDK for Singer Targets.",
"version": "0.0.7",
"project_urls": null,
"split_keywords": [
"elt",
" apprise"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6983cbf71aafd122e537925584e6df424108bf557a5d7f07e761f931bf749b6c",
"md5": "97f0c8d0c37948a9bb6d47df8ee4b4e2",
"sha256": "204b8d61d6e90aa1d5f457d4f8ad659a537e958a9f3fa5875e3de09395ef991f"
},
"downloads": -1,
"filename": "target_apprise-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97f0c8d0c37948a9bb6d47df8ee4b4e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.7.1",
"size": 5668,
"upload_time": "2024-10-22T19:16:03",
"upload_time_iso_8601": "2024-10-22T19:16:03.128946Z",
"url": "https://files.pythonhosted.org/packages/69/83/cbf71aafd122e537925584e6df424108bf557a5d7f07e761f931bf749b6c/target_apprise-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "886914ddf4cbee69592f4d938ee83a284dd857bc07b055388e4aab96ec445b9b",
"md5": "5ba9e3263cf60f69be36ad39f0300816",
"sha256": "9f430ab5e21b60b7be3013732388a5d0ec39e4d28d898324c3f3631ab9d2a904"
},
"downloads": -1,
"filename": "target_apprise-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "5ba9e3263cf60f69be36ad39f0300816",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.7.1",
"size": 4366,
"upload_time": "2024-10-22T19:16:04",
"upload_time_iso_8601": "2024-10-22T19:16:04.853924Z",
"url": "https://files.pythonhosted.org/packages/88/69/14ddf4cbee69592f4d938ee83a284dd857bc07b055388e4aab96ec445b9b/target_apprise-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 19:16:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "target-apprise"
}
