In-depth Guides

The following pages contain useful information for developers building on top of the Singer SDK.

• Singer Tap Porting Guide
  • A Clear Slate
  • Settings and Readme
  • If you are building a SQL tap
  • Authentication
  • Define your first stream
  • Install dependencies
  • Perform TODO items in tap.py and client.py
  • Test, debug, repeat, … until… success!
  • Define pagination
  • Run pytest
  • Create the remaining streams
  • Run pytest again, add stream properties, and repeat
  • Optional Next Steps
• Migrate your REST tap to use the new pagination classes!
  • What’s changed?
  • Why is this change being made?
  • How to migrate
• Custom CLIs
  • Overview
  • Adding a custom command
• Defining a configuration schema
• Building SQL taps
  • Mapping SQL types to JSON Schema