https://github.com/cubewise-code/tm1py
TM1py is a Python package that wraps the TM1 REST API in a simple to use library.
https://github.com/cubewise-code/tm1py
cubewise ibm planning-analytics python tm1 tm1-rest-api
Last synced: 5 months ago
JSON representation
TM1py is a Python package that wraps the TM1 REST API in a simple to use library.
- Host: GitHub
- URL: https://github.com/cubewise-code/tm1py
- Owner: cubewise-code
- License: mit
- Created: 2015-10-18T14:50:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2026-01-12T19:55:38.000Z (5 months ago)
- Last Synced: 2026-01-13T00:48:55.319Z (5 months ago)
- Topics: cubewise, ibm, planning-analytics, python, tm1, tm1-rest-api
- Language: Python
- Homepage: https://tm1py.org
- Size: 7.37 MB
- Stars: 209
- Watchers: 75
- Forks: 118
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TM1py is the python package for IBM Planning Analytics (TM1).
``` python
with TM1Service(address='localhost', port=8001, user='admin', password='apple', ssl=True) as tm1:
subset = Subset(dimension_name='Month', subset_name='Q1', elements=['Jan', 'Feb', 'Mar'])
tm1.subsets.create(subset, private=True)
```
Features
=======================
TM1py offers handy features to interact with TM1 from Python, such as
- Functions to read data from cubes through cube views or MDX queries (e.g. `tm1.cells.execute_mdx`)
- Functions to write data to cubes (e.g. `tm1.cells.write`)
- Functions to update dimensions and hierarchies (e.g. `tm1.hierarchies.get`)
- Functions to update metadata, clear or write to cubes directly from pandas dataframes (e.g. `tm1.elements.get_elements_dataframe`)
- Async functions to easily parallelize your read or write operations (e.g. `tm1.cells.write_async`)
- Functions to execute TI process or loose statements of TI (e.g. `tm1.processes.execute_with_return`)
- CRUD features for all TM1 objects (cubes, dimensions, subsets, etc.)
Requirements
=======================
- [Python](https://www.python.org/downloads/) (3.7 or higher)
- [TM1/Planning Analytics](https://www.ibm.com/products/planning-analytics) (v11 or higher)
Optional Python Packages
=======================
- pandas
- networkx
Install
=======================
> without pandas
pip install tm1py
> with pandas
pip install "tm1py[pandas]"
Usage
=======================
> TM1 11 on-premise
``` python
from TM1py.Services import TM1Service
with TM1Service(address='localhost', port=8001, user='admin', password='apple', ssl=True) as tm1:
print(tm1.server.get_product_version())
```
> TM1 11 on IBM cloud
``` python
with TM1Service(
base_url='https://mycompany.planning-analytics.ibmcloud.com/tm1/api/tm1/',
user="non_interactive_user",
namespace="LDAP",
password="U3lSn5QLwoQZY2",
ssl=True,
verify=True,
async_requests_mode=True) as tm1:
print(tm1.server.get_product_version())
```
> TM1 12 PAaaS
``` python
from TM1py import TM1Service
params = {
"base_url": "https://us-east-1.planninganalytics.saas.ibm.com/api//v0/tm1//",
"user": "apikey",
"password": "",
"async_requests_mode": True,
"ssl": True,
"verify": True
}
with TM1Service(**params) as tm1:
print(tm1.server.get_product_version())
```
> TM1 12 on-premise & Cloud Pak For Data
``` python
with TM1Service(
address="tm1-ibm-operands-services.apps.cluster.your-cluster.company.com",
instance="your instance name",
database="your database name",
application_client_id="client id",
application_client_secret="client secret",
user="admin",
ssl=True) as tm1:
print(tm1.server.get_product_version())
```
> TM1 12 on-premise with access token
``` python
params = {
"base_url": "https://pa12.dev.net/api//v0/tm1/",
"user": "8643fd6....8a6b",
"access_token":"",
"async_requests_mode": True,
"ssl": True,
"verify": True
}
with TM1Service(**params) as tm1:
print(tm1.server.get_product_version())
```
Documentation
=======================
Issues
=======================
If you find issues, sign up in GitHub and open an Issue in this repository
Contribution
=======================
TM1py is an open source project. It thrives on contribution from the TM1 community.
If you find a bug or feel like you can contribute please fork the repository, update the code and then create a pull request so we can merge in the changes.