Apache Airflow API (Stable)
Project description
Apache Airflow Python Client
Requirements.
Python >= 3.6
Installation & Usage
pip install
You can install directly using pip:
pip install git+https://github.com/apache/airflow-client-python.git
Setuptools
Or install via Setuptools.
git clone git@github.com:apache/airflow-client-python.git
cd airflow-client-python
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import airflow_client.client
Getting Started
Please follow the installation procedure and then run the following:
import airflow_client.client
from pprint import pprint
from airflow_client.client.api import config_api
# The client must use the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
#
# In case of the basic authentication below, make sure that Airflow is
# configured with the basic_auth as backend:
#
# auth_backend = airflow.api.auth.backend.basic_auth
#
# Make sure that your user/name are configured properly
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
host="http://localhost/api/v1",
username='admin',
password='admin'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = config_api.ConfigApi(api_client)
try:
# Get current configuration
api_response = api_instance.get_config()
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling ConfigApi->get_config: %s\n" % e)
See README for full client API documentation.
Release Process
The Python client is generated using Airflow's openapi spec. To update the client for new APIs do the following steps:
# clone this repo
git clone git@github.com:apache/airflow-client-python.git
# clone Airflow repo (if not already)
git clone git@github.com:apache/airflow.git
cd airflow
# bump up the version in python.sh & run the following command
./clients/gen/python.sh airflow/api_connexion/openapi/v1.yaml ../airflow-client-python/airflow_client
# raise a PR in github for both the repos (airflow & airflow-client-python)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
apache-airflow-client-2.0.0rc3.tar.gz
(112.6 kB
view hashes)
Built Distribution
Close
Hashes for apache-airflow-client-2.0.0rc3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c06b07a4b05c8d2121f4a764f1e2a5fa87193869f7b5ad3f6409809c925e0daf |
|
MD5 | 51804ef37103ad9a0b708ec593a70044 |
|
BLAKE2b-256 | 424edf075aa333804c8edd80ca05306ce67b52a93c2bcec479644b3bb63e2368 |
Close
Hashes for apache_airflow_client-2.0.0rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ad5a0e85f0e376c79aeddb71deaad57aa7fdfb2eb61eab26322f661eff7e16e |
|
MD5 | 84993e7920d1cc2b28b57c8c2c3f9f1d |
|
BLAKE2b-256 | 05308fd5c4fe4865880c1004846bb6fdefa7a7ac10bc1443e934dad1d5025695 |