Skip to main content

Note: this was an old proof of concept for Airflow 1.x and probably isn't useful for most people

I've started a airflow 2 style provider at https://github.com/scrambldchannel/airflow-provider-tm1, help wanted ;)

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

Metadata

Release files for airflow-tm1 0.0.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for airflow-tm1 0.0.13
File Interpreter ABI Platform
airflow_tm1-0.0.13-py3-none-any.whl Python 3 none any Details

Release files / airflow_tm1-0.0.13-py3-none-any.whl

Download URL airflow_tm1-0.0.13-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6bdf7f787001ca3e0a4f52d15b18e5f45e2abbd3d6247929c5f076e55108d395
BLAKE2b-256 checksum
How to use checksums
4df65dd6bb58c10c3d117f161039d5143adf62e917c8747730255209c28a08aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.7

Release history Release notifications | RSS feed

This release

0.0.13 This release

1 release file

0.0.12

1 release file

0.0.10

2 release files

0.0.9

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page