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
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
File details
Details for the file airflow-tm1-0.0.7.tar.gz.
File metadata
- Download URL: airflow-tm1-0.0.7.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cd77091131150fbb8e0f7be69431aec949a930b367e853c0c7561f220959c9ad |
|
| MD5 | 09cd8a96bd7dafad03ad3d6fc21b7946 |
|
| BLAKE2b-256 | fa81af92795c83ff375cd896e0c7635ff1d37551a5b2f19b7e5bd77ac33eb294 |
File details
Details for the file airflow_tm1-0.0.7-py3-none-any.whl.
File metadata
- Download URL: airflow_tm1-0.0.7-py3-none-any.whl
- Upload date:
- Size: 9.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 609514afcdfc6b0bdc037e7f9beac1b055ee20e077b65058710563e75cb4b6bf |
|
| MD5 | 377fb5467e6ea4c58ecb1a42d0bc10ff |
|
| BLAKE2b-256 | e7dd50d5f0c57e393cb170ff7ab39553cb5c4b979243befd4b3b1b337da175a2 |
