Giter Club home page Giter Club logo

tap-starshipit's Introduction

tap-starshipit

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

This tap:

  • Pulls raw data from StarShipIt's API
  • Extracts Shipped & Unshipped Orders & Get Order resources
  • Outputs the schema for each resource

Data is incrementally extracted based on the last

Get Order is fetched from the data retrieved by Shipped and Unshipped orders.

The catalog is dynamic created if not defined on the command line to use an static file.

Configuration

Take a look at the example config as a starting point for creating your own.

The tap requires the developer Subscription Key which needs to be registered (https://developers.starshipit.com/api-key) and the account API KEY.

Config properties:

Property Example Description
subscription_key "64d*******a94" the Developer Subscription Key
api_key "8pp*******z99" StarShipIt API Key
start_date "2010-01-01T00:00:00Z" The default start date to use.

Installation

pip install https://github.com/Zookal/tap-starshipit/archive/0.0.1.zip

Usage

First read through Singer's Running and Developing Singer Taps and Targets for getting started with running a tap and target.

For basic usage, run tap-starshipit with the configuration file.

Discovery:

tap-starshipit -c my-config.json --discover

Sync:

tap-starshipit -c my-config.json --catalog my-catalog.json

Sync using Dynamic Catalog discovery:

tap-starshipit -c my-config.json --state state.json

Short cuts for development purposes

export PYTHONPATH=$PYTHONPATH:$(pwd)
python tap_starshipit/__init__.py -c config.json

tap-starshipit's People

Watchers

 avatar  avatar

Forkers

peliqan-io

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.