| Name | tap-freshservice JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | |
| Summary | `tap-freshservice` is a Singer tap for Freshservice, built with the Meltano Singer SDK. |
| upload_time | 2024-01-03 20:01:42 |
| maintainer | |
| docs_url | None |
| author | Datateer Dev |
| requires_python | >=3.7.1,<3.12 |
| license | Apache-2.0 |
| keywords |
elt
freshservice
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-freshservice
`tap-freshservice` is a Singer tap for Freshservice.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Installation
Install from PyPi:
```bash
pipx install tap-freshservice
```
Install from GitHub:
```bash
pipx install git+https://github.com/Datateer/tap-freshservice.git@main
```
## Configuration
### Accepted Config Options
<!--
This section can be created by copy-pasting the CLI output from:
```
tap-freshservice --about --format=markdown
```
-->
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| api_key | True | None | The Freshservice API key |
| updated_since | False | 2000-01-01T00:00:00Z | The earliest record date to sync. You probably need this! The Freshservice API only returns items less than 30 days old. To override this, you must include an 'updated_since' value in the URL querystring. Providing a value here will ensure this value is used if there is no state (i.e. for a full refresh). |
| base_url | False | https://<replace with your org>.freshservice.com/api/v2 | The url for the Freshservice API |
| 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 for this
tap is available by running:
```bash
tap-freshservice --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.
## Usage
You can easily run `tap-freshservice` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-freshservice --version
tap-freshservice --help
tap-freshservice --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-freshservice` CLI interface directly using `poetry run`:
```bash
poetry run tap-freshservice --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._
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-freshservice
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-freshservice --version
# OR run a test `elt` pipeline:
meltano elt tap-freshservice 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-freshservice",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,Freshservice",
"author": "Datateer Dev",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ab/d4/2006209d51e7dfc6fa5c09bd93a68791af405bd945e32ad452e101900ae0/tap_freshservice-0.6.1.tar.gz",
"platform": null,
"description": "# tap-freshservice\n\n`tap-freshservice` is a Singer tap for Freshservice.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-freshservice\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/Datateer/tap-freshservice.git@main\n```\n\n\n## Configuration\n\n### Accepted Config Options\n\n<!--\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntap-freshservice --about --format=markdown\n```\n-->\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| api_key | True | None | The Freshservice API key |\n| updated_since | False | 2000-01-01T00:00:00Z | The earliest record date to sync. You probably need this! The Freshservice API only returns items less than 30 days old. To override this, you must include an 'updated_since' value in the URL querystring. Providing a value here will ensure this value is used if there is no state (i.e. for a full refresh). |\n| base_url | False | https://<replace with your org>.freshservice.com/api/v2 | The url for the Freshservice API |\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\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-freshservice --about\n```\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## Usage\n\nYou can easily run `tap-freshservice` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-freshservice --version\ntap-freshservice --help\ntap-freshservice --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-freshservice` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-freshservice --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\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-freshservice\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-freshservice --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-freshservice 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-freshservice` is a Singer tap for Freshservice, built with the Meltano Singer SDK.",
"version": "0.6.1",
"project_urls": null,
"split_keywords": [
"elt",
"freshservice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48614da50bcd9f51f10ba99f8faf299ca9d06ba6c84e7e9e6a271d8d2e8edbdd",
"md5": "2fe95ad1d34d583e72cb07bea2dd26df",
"sha256": "50b4bda26312fa075c76dbd8c340331bcd276f54cdd85eedbd0c7cda51d67f2e"
},
"downloads": -1,
"filename": "tap_freshservice-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fe95ad1d34d583e72cb07bea2dd26df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 15557,
"upload_time": "2024-01-03T20:01:41",
"upload_time_iso_8601": "2024-01-03T20:01:41.356796Z",
"url": "https://files.pythonhosted.org/packages/48/61/4da50bcd9f51f10ba99f8faf299ca9d06ba6c84e7e9e6a271d8d2e8edbdd/tap_freshservice-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "abd42006209d51e7dfc6fa5c09bd93a68791af405bd945e32ad452e101900ae0",
"md5": "fd4a85bd78e392cd34e9ee20cbd69861",
"sha256": "34f8892062612cd9f9eeb96bffddca0fc37e50ad266147a5e94bb3666ab73e67"
},
"downloads": -1,
"filename": "tap_freshservice-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "fd4a85bd78e392cd34e9ee20cbd69861",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 11944,
"upload_time": "2024-01-03T20:01:42",
"upload_time_iso_8601": "2024-01-03T20:01:42.904203Z",
"url": "https://files.pythonhosted.org/packages/ab/d4/2006209d51e7dfc6fa5c09bd93a68791af405bd945e32ad452e101900ae0/tap_freshservice-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-03 20:01:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-freshservice"
}
