Skip to main content
These features are particularly useful for automating spatial ETL workloads.

​
Benefits

You can use Airflow to streamline, automate, and manage complex ETL workload tasks that are running on your data. For example, you might want to perform your training and inference on large datasets in batches rather than all at once due to potential efficiency increases. Airflow can schedule these batch jobs to run at specific time intervals or trigger those batch jobs based on events like the arrival of new data.

​
Before you start

Before installing the Wherobots Apache Airflow Provider, ensure that you have the following required resources:
  • Python version 3.8, 3.9, 3.10, 3.11, or 3.12.
    Python 3.13 is not yet supported. For details on how to circumvent this limitation, see the uv tab in Install from PyPI.
  • Wherobots API key. For more information, see API keys in the Wherobots documentation.
  • Apache Airflow. For more information see, Installation of Airflow in the Apache Airflow documentation.

​
Setup

You can install the Wherobots Apache Airflow provider with pip or uv pip. You can also add the Wherobots Apache Airflow provider to the dependencies of your Apache Airflow application.

​
Install from PyPI

To install the Wherobots Apache Airflow provider, run the following commands in your terminal: 
pip install airflow-providers-wherobots

​
Create a new Connection in Airflow Server

You first need to create a Connection in the Airflow Server. There are two ways to create a connection: through the CLI or through the UI.

​
Create through CLI

You can create the connection through the Apache Airflow CLI. Execute the following from your command line, replacing $(< api.key) with your Wherobots API key. 
airflow connections add "wherobots_default" \
  --conn-type "generic" \
  --conn-host "api.cloud.wherobots.com" \
  --conn-password "$(< api.key)"
These commands should return a link to the Airflow Server. For more information, see Managing Connections in the Apache Airflow Documentation.

​
Create through UI

Or you can create the connection through the Apache Airflow UI following the steps below:
1
Navigate to your Apache Airflow UI home page. click the Admin tab on the top right corner, and select Connections.
Airflow UI connections
2
Click the + button to add a new connection.
Airflow UI connections
3
Fill in the connection details:
4
Connection ID: wherobots_default
5
Connection Type: generic
6
Host: api.cloud.wherobots.com
7
Password: Your Wherobots API key
Airflow UI connections
8
Click Save to confirm the connection.