TM1py 2.2__tar.gz → 2.2.2__tar.gz

{TM1py-2.2 → tm1py-2.2.2}/LICENSE

@@ -1,22 +1,22 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Cubewise CODE
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+The MIT License (MIT)
+
+Copyright (c) 2017 Cubewise CODE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

{TM1py-2.2 → tm1py-2.2.2}/PKG-INFO

@@ -1,180 +1,181 @@
-Metadata-Version: 2.1
-Name: TM1py
-Version: 2.2
-Summary: A python module for TM1.
-Home-page: https://github.com/cubewise-code/tm1py
-Download-URL: https://github.com/Cubewise-code/TM1py/tarball/2.2
-Author: Marius Wirtz
-Author-email: MWirtz@cubewise.com
-License: MIT
-Keywords: TM1,IBM Cognos TM1,Planning Analytics,PA,Cognos
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Natural Language :: English
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Provides-Extra: pandas
-Provides-Extra: dev
-License-File: LICENSE
-
-<h1 align="center">
-<img src="https://s3-ap-southeast-2.amazonaws.com/downloads.cubewise.com/web_assets/CubewiseLogos/TM1py-logo.png" style="width: 70%; height: 70%;text-align: center"/>
-
-
-![PyPI - License](https://img.shields.io/pypi/l/TM1py)
-![PyPI - Version](https://img.shields.io/pypi/v/TM1py)
-![Pepy Total Downloads](https://img.shields.io/pepy/dt/TM1py)
-</h1>
-
-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 (3.7 or higher)
-- requests
-- requests_negotiate_sspi
-- TM1 11, TM1 12
-- keyring
-
-
-Optional Requirements
-=======================
-
-- pandas
-
-Install
-=======================
-
-> without pandas
-
-    pip install tm1py
-    
-> with pandas
-
-    pip install "tm1py[pandas]"
-    
-> keyring
-
-    pip install keyring
-
-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/<TenantId>/v0/tm1/<DatabaseName>/",
-    "user": "apikey",
-    "password": "<TheActualApiKey>",
-    "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/<InstanceId>/v0/tm1/<DatabaseName>",
-    "user": "8643fd6....8a6b",
-    "access_token":"<TheActualAccessToken>",
-    "async_requests_mode": True,
-    "ssl": True,
-    "verify": True
-}
-
-with TM1Service(**params) as tm1:
-    print(tm1.server.get_product_version())
-```
-
-
-Documentation
-=======================
-
-https://tm1py.readthedocs.io/en/master/
-
-
-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.
+Metadata-Version: 2.4
+Name: TM1py
+Version: 2.2.2
+Summary: A python module for TM1.
+Author-email: Marius Wirtz <MWirtz@cubewise.com>
+License: MIT
+Project-URL: Homepage, https://github.com/cubewise-code/tm1py
+Project-URL: Download, https://github.com/cubewise-code/tm1py/releases/latest
+Keywords: TM1,IBM Cognos TM1,Planning Analytics,PA,Cognos
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Natural Language :: English
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ijson
+Requires-Dist: requests
+Requires-Dist: pytz
+Requires-Dist: requests_negotiate_sspi; platform_system == "Windows"
+Requires-Dist: mdxpy>=1.3.1
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == "pandas"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: python-dateutil; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/cubewise-code/tm1py/master/Images/Logo.svg" style="width: 70%; height: 70%; text-align: center"/>
+
+![PyPI - License](https://img.shields.io/pypi/l/TM1py)
+![PyPI - Version](https://img.shields.io/pypi/v/TM1py)
+![Pepy Total Downloads](https://img.shields.io/pepy/dt/TM1py)
+</h1>
+
+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/<TenantId>/v0/tm1/<DatabaseName>/",
+    "user": "apikey",
+    "password": "<TheActualApiKey>",
+    "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/<InstanceId>/v0/tm1/<DatabaseName>",
+    "user": "8643fd6....8a6b",
+    "access_token":"<TheActualAccessToken>",
+    "async_requests_mode": True,
+    "ssl": True,
+    "verify": True
+}
+
+with TM1Service(**params) as tm1:
+    print(tm1.server.get_product_version())
+```
+
+Documentation
+=======================
+
+<https://tm1py.org/>
+
+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.