Skip to content
No description, website, or topics provided.
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
tap_clubspeed
tests
.gitignore
CHANGELOG.md
LICENSE
MANIFEST.in
Makefile
README.md
package-lock.json
setup.cfg
setup.py

README.md

tap-clubspeed

Tap for Clubspeed.

Requirements

  • pip3
  • python 3.5+
  • mkvirtualenv

Installation

$ mkvirtualenv -p python3 tap-clubspeed
$ pip3 install tap-clubspeed

Usage

Create config file

This config is to authenticate into Clubspeed.

{
  "subdomain": "your_subdomain",
  "private_key": "********"
}

Discovery mode

This command returns a JSON that describes the schema of each table.

$ tap-clubspeed --config config.json --discover

Field selection

You can tell the tap to extract specific fields by using a catalog.json file.

$ tap-clubspeed --config config.json --discover > catalog.json

Then, edit catalog.json to make selections. Note the top-level selected attribute, as well as the selected attribute nested under each property.

{
  "selected": "true",
  "properties": {
    "likes_getting_petted": {
      "selected": "true",
      "inclusion": "available",
      "type": [
        "null",
        "boolean"
      ]
    },
    "name": {
      "selected": "true",
      "maxLength": 255,
      "inclusion": "available",
      "type": [
        "null",
        "string"
      ]
    },
    "id": {
      "selected": "true",
      "minimum": -2147483648,
      "inclusion": "automatic",
      "maximum": 2147483647,
      "type": [
        "null",
        "integer"
      ]
    }
  },
  "type": "object"
}

Sync Mode

With an annotated catalog.json, the tap can be invoked in sync mode:

$ tap-clubspeed --config config.json --catalog catalog.json

Messages are written to standard output following the Singer specification. The resultant stream of JSON data can be consumed by a Singer target.

Replication Methods and State File

Incremental

Incremental replication works in conjunction with a state file to only extract new records each time the tap is invoked.

Tests

$ make test

Copyright © 2018 Stitch

You can’t perform that action at this time.