tap-clockify

Author: Stephen Bailey (sbailey@immuta.com)

This is a Singer tap that produces JSON-formatted data following the Singer spec.

It can generate a catalog of available data in Clockify and extract the following resources:

• clients
• projects
• tags
• tasks
• time entries
• users
• workspaces

Configuration

{
  "api_key": "string",
  "workspace": "string",
  "start_date": "2020-04-01T00:00:00Z"
}

Quick Start

1. Install

git clone git@github.com:immuta/tap-clockify.git
cd tap-clockify
pip install .

2. Get an API key from Clockify

3. Create the config file.

There is a template you can use at config.json.example, just copy it to config.json in the repo root and insert your token

4. Run the application to generate a catalog.

tap-clockify -c config.json --discover > catalog.json

5. Select the tables you'd like to replicate

Step 4 generates a a file called catalog.json that specifies all the available endpoints and fields. You'll need to open the file and select the ones you'd like to replicate. See the Singer guide on Catalog Format for more information on how tables are selected.

6. Run it!

tap-clockify -c config.json --catalog catalog.json

Acknowledgements

Would like to acknowledge the folks at Fishtown Analytics whose tap-framework and tap-lever packages formed the foundation for this package.

Copyright © 2019 Immuta