Metadata-Version: 2.1
Name: airflow-tm1
Version: 0.0.10
Summary: A package to simplify connecting to the TM1 REST API from Apache Airflow
Author-email: Alexander Sutcliffe <sutcliffe.alex@gmail.com>
Description-Content-Type: text/markdown
Requires-Dist: tm1py ~= 1.1
Requires-Dist: apache-airflow ~= 2.1
Requires-Dist: pytest ; extra == "tests"
Provides-Extra: tests

# airflow-tm1

A package that provides a hook to simplify connecting to the IBM Cognos TM1 / Planning Analytics REST API.

## Requirements

* Python 3.6+
* Airflow
* TM1py

## Installation

Install with pip `pip install airflow-tm1`

## Usage

Create a connection in Airflow with at least the following parameters set:

* Host
* Login
* Port
* Extras
  * ssl

Any other parameter accepted by the TM1py RestService constructor (eg base_url, namespace etc) can also be added as a key in the Extras field in the connection.

In your DAG file:

```python
from airflow_tm1.hooks.tm1 import TM1Hook

tm1_hook = TM1Hook(tm1_conn_id="tm1_default")
tm1 = tm1_hook.get_conn()
```

This will attempt to connect to the TM1 server using the details provided and initialise an instance of the TM1Service class than be accessed at `tm1_hook.tm1`

See [TM1py](https://github.com/cubewise-code/tm1py) for more details.

## License

See [LICENSE](https://github.com/scrambldchannel/airflow-tm1/LICENSE)




