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.7+
- Airflow 1.x
- 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 Distributions
Built Distribution
Hashes for airflow_tm1-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08a37f28f2357a72d847ec6f170814fe7bafe4f4f9433d4cb4c4a454ac1da6a8 |
|
MD5 | f57d382a5c8579cf59d8f5c6d39d0412 |
|
BLAKE2b-256 | 74bf7fc5bdfd12b3fb4da76114adbb45f5ac98db3ae6bddb7a7771eb0cd8958e |