Structuring your provider

Airflow providers are simply Python packages, with a few special interfaces and implementations to ensure that they integrate well into the core Airflow code base. If you’ve ever written a Python package for distribution, most of the steps and tasks within this chapter should feel familiar to you.

General directory structure

Important note

There are a lot of boilerplate directories, files, and code required to make a distributable package. As such, a number of templating engines (and templates) have been created to lower the burden of setting up projects. We use Angreal and that equips Airflow provider template to create this boilerplate. You can create your own provider with this system using the following commands:

pip install angreal

angreal init airflow_provider

Let’s begin by looking at the important directories and files within our teapot provider package:

.
├── airflow_provider_tea_pot
│...