search

AutoIDM / tap-clickup

tap-clickup , singer compliant tap for pulling clickup data
MIT License
12 stars 19 forks source link

API_key? && Big thank you #108

Closed RR-Helpdesk closed 2 years ago

RR-Helpdesk commented 2 years ago

First, thank you for making this. I've been searching for a ClickUp connector forever, you are my hero this week!

Seeing this for the first time with outside eyes, it's not clear where you store or place the API_key and I haven't been able to figure it out. When passing the --config or -config flags, it doesn't seem to work either. Any insight would be awesome.

Screen Shot 2022-01-26 at 7 59 46 AM Screen Shot 2022-01-26 at 7 56 56 AM
visch commented 2 years ago

Thanks for the thank you!

So this "tap" is following a spec called Singer (I should probably call this out). https://github.com/singer-io/getting-started is official, but I think https://hub.meltano.com/singer/spec is easier to skim/read.

Taps (like this one tap-clickup) expect a config to be passed into them, ie tap-clickup --config=config.json This config file needs to have the api key

To skip a lot of this boiler plate setup (if you're just looking to get data to work with), use the steps at the bottom of the readme for Meltano https://github.com/AutoIDM/tap-clickup#testing-with-meltano . Install meltano (then you can add the api_key to https://github.com/AutoIDM/tap-clickup/blob/main/meltano.yml#L6

Something like

config:
  api_key: abc

Would work.

visch commented 2 years ago

If you use Meltano then in airflow you can use (a bash operator I think they call it) a command like meltano elt tap-clickup target-csv or something like that

visch commented 2 years ago

Just realized you were running pytest, yes to get that working set https://github.com/AutoIDM/tap-clickup/blob/main/tap_clickup/tests/test_core.py#L12 the env variable there (no config needed, you can setup a .env if you want, probably should support both use cases)

RR-Helpdesk commented 2 years ago

Thanks, everyone, that was really helpful. just getting familiar with Singer and noticed the same with some other taps as well.

visch commented 2 years ago

Everything working? Good to close this?