A package to simplify connecting to the TM1 REST API from Apache Airflow
Project description
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:
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 for more details.
License
See LICENSE
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
Built Distribution
Hashes for airflow_tm1-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 609514afcdfc6b0bdc037e7f9beac1b055ee20e077b65058710563e75cb4b6bf |
|
MD5 | 377fb5467e6ea4c58ecb1a42d0bc10ff |
|
BLAKE2b-256 | e7dd50d5f0c57e393cb170ff7ab39553cb5c4b979243befd4b3b1b337da175a2 |