Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/transferwise/pipelinewise-tap-zendesk
Singer.io Tap for Zendesk API - PipelineWise compatible
https://github.com/transferwise/pipelinewise-tap-zendesk
Last synced: 3 months ago
JSON representation
Singer.io Tap for Zendesk API - PipelineWise compatible
- Host: GitHub
- URL: https://github.com/transferwise/pipelinewise-tap-zendesk
- Owner: transferwise
- License: agpl-3.0
- Created: 2020-02-19T08:01:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T14:24:09.000Z (5 months ago)
- Last Synced: 2024-09-13T01:40:17.749Z (5 months ago)
- Language: Python
- Homepage: https://transferwise.github.io/pipelinewise
- Size: 155 KB
- Stars: 0
- Watchers: 5
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Notice
To better serve Wise business and customer needs, the PipelineWise codebase needs to shrink.
We have made the difficult decision that, going forward many components of PipelineWise will be removed or incorporated in the main repo.
The last version before this decision is [v0.64.1](https://github.com/transferwise/pipelinewise/tree/v0.64.1)
We thank all in the open-source community, that over the past 6 years, have helped to make PipelineWise a robust product for heterogeneous replication of many many Terabytes, daily
# Pipelinewise-tap-zendesk
[](https://badge.fury.io/py/pipelinewise-tap-zendesk)
[](https://pypi.org/project/pipelinewise-tap-zendesk/)
[](https://opensource.org/licenses/GPL-3.0)
[Singer](https://www.singer.io/) tap that extracts data from a Zendesk API and produces JSON-formatted data following
the [Singer spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md).
This is a [PipelineWise](https://transferwise.github.io/pipelinewise) compatible tap connector.
## How to use it
The recommended method of running this tap is to use it from [PipelineWise](https://transferwise.github.io/pipelinewise). When running it from PipelineWise you don't need to configure this tap with JSON files and most of things are automated. Please check the related documentation at [Kafka](https://transferwise.github.io/pipelinewise/connectors/taps/zendesk.html)
If you want to run this [Singer Tap](https://singer.io) independently please read further.
## Install and Run
First, make sure Python 3 is installed on your system or follow these
installation instructions for [Mac](http://docs.python-guide.org/en/latest/starting/install3/osx/) or
[Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04).
It's recommended to use a virtualenv:
```bash
python3 -m venv venv
pip install pipelinewise-tap-zendesk
```
or
```bash
python3 -m venv venv
. venv/bin/activate
pip install --upgrade pip
pip install -e .[test]
```
### Configuration
### Authentication
### Using OAuth
OAuth is the default authentication method for `tap-zendesk`. To use OAuth, you will need to fetch an `access_token` from a configured Zendesk integration. See https://support.zendesk.com/hc/en-us/articles/203663836 for more details on how to integrate your application with Zendesk.
**config.json**
```json
{
"access_token": "AVERYLONGOAUTHTOKEN",
"subdomain": "acme",
"start_date": "2000-01-01T00:00:00Z"
}
```
### Using API Tokens
For a simplified, but less granular setup, you can use the API Token authentication which can be generated from the Zendesk Admin page. See https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token- for more details about generating an API Token. You'll then be able to use the admins's `email` and the generated `api_token` to authenticate.
**config.json**
```json
{
"email": "[email protected]",
"api_token": "THISISAVERYLONGTOKEN",
"subdomain": "acme",
"start_date": "2000-01-01T00:00:00Z"
}
```
### Run the tap in Discovery Mode
```
tap-zendesk --config config.json --discover # Should dump a Catalog to stdout
tap-zendesk --config config.json --discover > catalog.json # Capture the Catalog
```
### Run the tap in Sync Mode
```
tap-zendesk --config config.json --catalog catalog.json
```
The tap will write bookmarks to stdout which can be captured and passed as an optional `--state state.json` parameter to the tap for the next sync.
### To run tests:
1. Install python test dependencies in a virtual env and run tests
```
make venv
```
2. To run tests:
```
make unit_test
```
### To run pylint:
1. Install python dependencies and run python linter
```
make venv pylint
```