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.
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. |
pip install https://github.com/Zookal/tap-starshipit/archive/0.0.1.zip
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