arrow Videos

CloudQuery: Write a CloudQuery Source Plugin in Python

date October 20, 2023

A 10-minute hands-on demo of how to write a CloudQuery Plugin from start to finish, using the XKCD API as an example.
Tim Armstrong Tim Armstrong, Founder, Consultant Engineer, Expert in Performance & Security
CloudQuery: Write a CloudQuery Source Plugin in Python

SHARE

linkedin share twitter share reddit share

Description:

A 10-minute hands-on demo of how to write a CloudQuery Plugin from start to finish, using the XKCD API as an example.

CloudQuery has a lot of built-in plugins, but sometimes… you need a plugin for something that isn’t already covered.

This tutorial takes you on a deep dive into how source plugins work and how to build your own using the new Python SDK. To do this, we show you how to develop source plugins for CloudQuery in Python using the XKCD API.

The new CloudQuery Python SDK opens up source plugin development to many more developers than before. Enabling easy integration with popular Python libraries that connect to APIs for things like Fintech data, GIS data, or network telemetry.

Links: CloudQuery website: https://cql.ink/47gzyZ6 Plugin Developer Documentation: https://cql.ink/47hrXcu CloudQuery Architecture: https://cql.ink/3sjhWgd Python Template: https://cql.ink/3FIUrjW Result of this tutorial: https://cql.ink/40q1NlY Join our Discord: https://cql.ink/40nU2g1

Chapters: 00:00 - Overview 00:45 - The Template Repo 01:24 - The XKCD API 02:18 - Building the Table 05:51 - Building the API Client 08:02 - Editing the Config Spec 08:27 - Setting the Plugin’s Name and Version 09:08 - Testing the Plugin and Fixing Common Mistakes 10:45 - Outro

arrow Videos overview