Skip to content

Latest commit

 

History

History
232 lines (175 loc) · 8.55 KB

README.md

File metadata and controls

232 lines (175 loc) · 8.55 KB
Raw

tap-clickup Build and Tests PyPI download month

tap-clickup is a Singer tap for ClickUp. Tap was created by AutoIDM only because multiple community members came together to get this tap created. Check AutoIDM out for tap/target creation, maintenace, support, and more!

AutoIDM

Sponsors

This tap is only available due to the amazing folks who pitched together to make this happen.

trek10

Note that some sponsors may not be listed here.

Want to become a sponsor? Reach out to us at autoidm.com

Capabilities

  • sync
  • catalog
  • discover

Settings

Setting Required Default Description
api_token True None Example: 'pk_12345'

A full list of supported settings and capabilities is available by running: tap-clickup --about

Getting an API Token

  1. Login at https://app.clickup.com/
  2. Click your icon at the bottom left of the screen
  3. Click My Settings
  4. Click Apps (Bottom leftish of screen under the My Apps sub section)
  5. At the top of the screen is an API Token. This can be used in the api_token location.
    • This is a personal token, it's fine to use a personal token as this tap is only for the business that's using the data.

Clickup Replication

Start Date is used for the initial updated at value for the updated at field with tasks.

Let's say that you only want tasks that have been updated in the last year. To accomplish this you would pass in a start date of the first of this year!

Clickup Table Schemas

Note that the most up to date information is located in tap_clickup/streams.py. We will try to keep these docs updated

Teams

  • Table name: team
  • Description: Teams Data, each user can be in multiple teams
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Teams

Spaces

  • Table name: space
  • Description: Each team has multiple spaces
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Spaces

Time Entries

  • Table name: time_entries
  • Description: All time entries are pulled for every team. Didn't do incremental as we have AutoIDM#95 open still
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Time Entries

Folders

  • Table name: folder
  • Description: Each space can have multiple folders
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Folders

Folder Lists

  • Table name: folder_list
  • Description: Each Folder can have multiple lists
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation:Folder Lists

Folderless Lists

  • Table name: folderless_list
  • Description: Some lists do not exist in a folder
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Folderless Lists

Task Templates

  • Table name: task_template
  • Description: Tasks can be templated for any reason you can imagine!
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Task Templates

Goals

  • Table name: goal
  • Description: Teams can set goals for themselves
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Goals

Tags

  • Table name: tag
  • Description: Each space can have multiple tags
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Tags

Shared Hierarchy

  • Table name: shared_hierarchy
  • Description: Returns all resources you have access to where you don't have access to its parent. For example, if you have a access to a shared task, but don't have access to its parent list, it will come back in this request.
  • Primary key column(s): (No primary key column)
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Shared Hierarchy

Custom Fields from Folderless Lists

  • Table name: folderless_customfield
  • Description: Each Folderless lists can have custom fields associated with them
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Custom Field

Custom Field from Folder Lists

  • Table name: folder_customfield
  • Description: Each Foldere list can have custom fields associated with them
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): N/A
  • Link to API endpoint documentation: Custom Field

Tasks

  • Table name: tasks
  • Description: Some tasks do not sit under folders. This comes from the folderless_list endpoint
  • Primary key column(s): id
  • Replicated fully or incrementally: No
  • Bookmark column(s): date_updated. Note that the api endpoint date_updated_gt is great than or equal to, not just greater than.
  • Link to API endpoint documentation: Get Tasks

Other Info

Installation

pipx install tap-clickup

Usage

You can easily run tap-clickup by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-clickup --version
tap-clickup --help
tap-clickup --config CONFIG --discover > ./catalog.json

Developer Resources

Schema Debugging

We are waiting on https://gitlab.com/meltano/sdk/-/issues/299 to get fixed as we make usage of refs in our json schema. Until then we parse the schemas in client.py

Sometimes it's useful to debug how the refs are being resolved. To do that there's a script inside of ./schema-parser , README in that directory describes how to run the parser

Not worry about making this super fool proof as we expect the SDK to release some kind of fix for this

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_clickup/tests subfolder and then run:

poetry run pytest

You can also test the tap-clickup CLI interface directly using poetry run:

poetry run tap-clickup --help

Testing with Meltano

_Note: This tap will work in any Singer environment and does not require Meltano.

Install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-clickup
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-clickup --version
# OR run a test `elt` pipeline:
meltano elt tap-clickup target-jsonl

SDK

Built with the Meltano SDK for Singer Taps and Targets.