Metadata-Version: 2.1
Name: airflow-docker-helper
Version: 0.1.2
Summary: A light sdk to be used by the operators in airflow-docker and in task code to participate in host/container communication.
Home-page: https://github.com/huntcsg/airflow-docker-helper
Author: Hunter Senft-Grupp
Author-email: huntcsg@gmail.com
License: Apache License 2.0
Keywords: airflow docker
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: System :: Monitoring
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Provides-Extra: testing
Provides-Extra: linting
Provides-Extra: docs
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: linting
Requires-Dist: isort; extra == 'linting'
Requires-Dist: black; extra == 'linting'
Requires-Dist: flake8; extra == 'linting'
Provides-Extra: testing
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Provides-Extra: testing
Requires-Dist: mock; (python_version < "3") and extra == 'testing'

# Airflow Docker Helper
[![CircleCI](https://circleci.com/gh/huntcsg/airflow-docker-helper/tree/master.svg?style=svg)](https://circleci.com/gh/huntcsg/airflow-docker-helper/tree/master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3e2f177d8c314f43903fe9d9b7af0647)](https://www.codacy.com/app/fool.of.god/airflow-docker-helper?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=huntcsg/airflow-docker-helper&amp;utm_campaign=Badge_Grade) [![codecov](https://codecov.io/gh/huntcsg/airflow-docker-helper/branch/master/graph/badge.svg)](https://codecov.io/gh/huntcsg/airflow-docker-helper)

## Description
A light sdk to be used by the operators in airflow-docker and in task code to participate in host/container communication.

## Installation

```bash
pip install airflow-docker-helper
```

## Usage

### Sensor
```python
from airflow_docker_helper import client

if sensed:
    client.sensor(True)
else:
    client.sensor(False)
```

### Short Circuit

```python
from airflow_docker_helper import client

if should_short_circuit:
    client.short_circuit()
```

### Branching

You can pass a list...
```python
from airflow_docker_helper import client

branch_to_task_ids = ['foo', 'bar']

client.branch_to_tasks(branch_to_task_ids)

```

... or a string.
```python
from airflow_docker_helper import client

client.branch_to_tasks('some-other-task')

```


