myabcm-corporate-client-api 0.1.0__tar.gz

myabcm_corporate_client_api-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

myabcm_corporate_client_api-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.2
+Name: myabcm_corporate_client_api
+Version: 0.1.0
+Summary: MyABCM Corporate Python Client API
+Author-email: Clovis Ribeiro <clovis.ribeiro@myabcm.com>, Luiz Guilherme Oliveira <luiz.oliveira@myabcm.com>
+License: LGPL-3.0-only
+Project-URL: Homepage, https://www.myabcm.com
+Project-URL: Repository, https://github.com/myabcm/corporate-python-client-api
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+
+# MyABCM Corporate Python client API
+
+
+## Overview
+
+MyABCM Corporate (v12 or newer) provides a simple and extensive REST API for end users to connect and control MyABCM from other languages.
+
+The purpose of this package is to simplify the usage of MyABCM Corporate REST API by wrapping the most common calls in a simple to use Python class.
+
+
+
+## A bit of history
+
+MyABCM Corporate since its first versions, provided a REST API so users could control it from external systems/programs.
+
+To make the use of the REST API simpler, MyABCM even released a command line utility named "MyABCM.Client.Shell" that used the provided REST API to control the basic functions of MyABCM Corporate.
+
+The initial goal of "MyABCM.Client.Shell" was to serve as a simple example of the potential of MyABCM Corporate API but many users ended up using the utility in production to automate processes like model imports, calculation and fact/cube generation.
+
+MyABCM.Client.Shell certainly served its purpose, but it is limited in flexibility as it does not implement the functionality of a full scripting language. Due to that limitation came the idea of implementing a Python package that could wrap around MyABCM Corporate REST API and make it easier for end users to control MyABCM Corporate from Python scripts.
+
+
+
+## How does it work?
+
+This package implements a single class named **CorporateServer** that implements multiple methods to control MyABCM Corporate. 
+
+Here is a simple example of a Python script to connect to MyABCM and calculate a model:
+
+```python
+from myabcm_corporate_client_api import CorporateServer
+
+# Create a new instance of CorporateServer class with the provided servername and credentials
+corporate_server = CorporateServer("https://corporate.my-company.com/proxy", "user123", "myabcm123")
+
+# Logon to MyABCM Corporate
+corporate_server.logon()
+
+# Select a model 
+corporate_server.select_model("MY-MODEL-REFERENCE-ABC")
+
+# Execute calculation
+corporate_server.calculate_model("JAN2025", "ACTUAL" , False):
+
+# Logoff from MyABCM Corporate
+corporate_server.logoff()
+```
+
+## Methods provided by the CorporateServer class
+
+Here are all methods exposed by the CorporateServer class. Additional details on the parameters required for each method can be obtained directly from most Python code editors as the source code of the package is fully documented using *Docstrings*.
+
+&nbsp;  
+&nbsp;  
+
+> With the exception of **process_fact_associations**, all other methods are executed synchronously. This means if you call a method like **execute_import**, **execute_export** or any other method that executes as an operation in the server, the call will block until the operation ends.
+
+&nbsp;  
+&nbsp;  
+
+**Logon/logoff methods**
+
+Method | Description
+--- |---
+logon | Logon to the Corporate server informed in the class constructor
+logoff | Logoff from the server
+
+&nbsp;  
+&nbsp;  
+
+**Model related methods**
+
+Method | Description
+--- |---
+model_exists | Check if a model exists
+select_model | Select a model
+remove_model | Remove a model
+add_model | Add a new model
+calculate_model | Calculate a specific association
+reset_association | Reset an existing association
+remove_cubes_from_olap_server | Remove ALL cubes from OLAP Server (tabular and SSAS)
+
+&nbsp;  
+&nbsp;  
+
+**File store related methods**
+
+Method | Description
+--- |---
+upload_file | Upload a local file to the server
+download_file | Download a file from server
+file_exists | Check if a file exists in the user's file store
+remove_file | Remove a file from user's file store
+
+&nbsp;  
+&nbsp;  
+
+**Import related methods**
+
+Method | Description
+--- |---
+import_exists | Check if an import exists
+add_import | Add a new import
+remove_import | Remove an import
+execute_import | Execute import
+
+&nbsp;  
+&nbsp;  
+
+
+**Export related methods**
+
+Method | Description
+--- |---
+add_export | Add a new export
+remove_export | Remove an export
+execute_export | Execute an export
+
+&nbsp;  
+&nbsp;  
+
+**Scripts related methods**
+
+Method | Description
+--- |---
+add_script | Add a new script
+remove_script | Remove script
+execute_script | Execute script
+add_md_cube_to_script | Add a multidimensional cube to a script
+add_tb_cube_to_script | Add a tabular cube to a script
+add_export_to_script | Add an export to a script
+add_import_to_script | Add an import to a script
+add_model_calculation_to_script | Add a calculate model operation to a script
+add_etlx_file_to_script | Add an ETLX package processing operation to a script
+add_etlx_database_to_script | Add an ETLX(Database) package processing operation to a script
+add_fact_to_script | Add a fact processing operation to a script
+
+&nbsp;  
+&nbsp;  
+
+**Fact related methods**
+
+Method | Description
+--- |---
+add_fact_associations | Add new associations to a fact
+remove_fact_associations | Remove associations to a fact
+process_fact_associations | Process a fact association
+process_fact | Process all fact associations
+
+&nbsp;  
+&nbsp;  
+
+**Cube related methods**
+
+Method | Description
+--- |---
+process_regular_cube | Process a regular (SSAS) cube
+process_tabular_cube | Process a tabular cube

myabcm_corporate_client_api-0.1.0/README.md

@@ -0,0 +1,158 @@
+# MyABCM Corporate Python client API
+
+
+## Overview
+
+MyABCM Corporate (v12 or newer) provides a simple and extensive REST API for end users to connect and control MyABCM from other languages.
+
+The purpose of this package is to simplify the usage of MyABCM Corporate REST API by wrapping the most common calls in a simple to use Python class.
+
+
+
+## A bit of history
+
+MyABCM Corporate since its first versions, provided a REST API so users could control it from external systems/programs.
+
+To make the use of the REST API simpler, MyABCM even released a command line utility named "MyABCM.Client.Shell" that used the provided REST API to control the basic functions of MyABCM Corporate.
+
+The initial goal of "MyABCM.Client.Shell" was to serve as a simple example of the potential of MyABCM Corporate API but many users ended up using the utility in production to automate processes like model imports, calculation and fact/cube generation.
+
+MyABCM.Client.Shell certainly served its purpose, but it is limited in flexibility as it does not implement the functionality of a full scripting language. Due to that limitation came the idea of implementing a Python package that could wrap around MyABCM Corporate REST API and make it easier for end users to control MyABCM Corporate from Python scripts.
+
+
+
+## How does it work?
+
+This package implements a single class named **CorporateServer** that implements multiple methods to control MyABCM Corporate. 
+
+Here is a simple example of a Python script to connect to MyABCM and calculate a model:
+
+```python
+from myabcm_corporate_client_api import CorporateServer
+
+# Create a new instance of CorporateServer class with the provided servername and credentials
+corporate_server = CorporateServer("https://corporate.my-company.com/proxy", "user123", "myabcm123")
+
+# Logon to MyABCM Corporate
+corporate_server.logon()
+
+# Select a model 
+corporate_server.select_model("MY-MODEL-REFERENCE-ABC")
+
+# Execute calculation
+corporate_server.calculate_model("JAN2025", "ACTUAL" , False):
+
+# Logoff from MyABCM Corporate
+corporate_server.logoff()
+```
+
+## Methods provided by the CorporateServer class
+
+Here are all methods exposed by the CorporateServer class. Additional details on the parameters required for each method can be obtained directly from most Python code editors as the source code of the package is fully documented using *Docstrings*.
+
+   
+   
+
+> With the exception of **process_fact_associations**, all other methods are executed synchronously. This means if you call a method like **execute_import**, **execute_export** or any other method that executes as an operation in the server, the call will block until the operation ends.
+
+   
+   
+
+**Logon/logoff methods**
+
+Method | Description
+--- |---
+logon | Logon to the Corporate server informed in the class constructor
+logoff | Logoff from the server
+
+   
+   
+
+**Model related methods**
+
+Method | Description
+--- |---
+model_exists | Check if a model exists
+select_model | Select a model
+remove_model | Remove a model
+add_model | Add a new model
+calculate_model | Calculate a specific association
+reset_association | Reset an existing association
+remove_cubes_from_olap_server | Remove ALL cubes from OLAP Server (tabular and SSAS)
+
+   
+   
+
+**File store related methods**
+
+Method | Description
+--- |---
+upload_file | Upload a local file to the server
+download_file | Download a file from server
+file_exists | Check if a file exists in the user's file store
+remove_file | Remove a file from user's file store
+
+   
+   
+
+**Import related methods**
+
+Method | Description
+--- |---
+import_exists | Check if an import exists
+add_import | Add a new import
+remove_import | Remove an import
+execute_import | Execute import
+
+   
+   
+
+
+**Export related methods**
+
+Method | Description
+--- |---
+add_export | Add a new export
+remove_export | Remove an export
+execute_export | Execute an export
+
+   
+   
+
+**Scripts related methods**
+
+Method | Description
+--- |---
+add_script | Add a new script
+remove_script | Remove script
+execute_script | Execute script
+add_md_cube_to_script | Add a multidimensional cube to a script
+add_tb_cube_to_script | Add a tabular cube to a script
+add_export_to_script | Add an export to a script
+add_import_to_script | Add an import to a script
+add_model_calculation_to_script | Add a calculate model operation to a script
+add_etlx_file_to_script | Add an ETLX package processing operation to a script
+add_etlx_database_to_script | Add an ETLX(Database) package processing operation to a script
+add_fact_to_script | Add a fact processing operation to a script
+
+   
+   
+
+**Fact related methods**
+
+Method | Description
+--- |---
+add_fact_associations | Add new associations to a fact
+remove_fact_associations | Remove associations to a fact
+process_fact_associations | Process a fact association
+process_fact | Process all fact associations
+
+   
+   
+
+**Cube related methods**
+
+Method | Description
+--- |---
+process_regular_cube | Process a regular (SSAS) cube
+process_tabular_cube | Process a tabular cube

myabcm_corporate_client_api-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "myabcm_corporate_client_api"
+
+version = "0.1.0"
+
+authors = [
+    { name="Clovis Ribeiro", email="clovis.ribeiro@myabcm.com" },
+	{ name="Luiz Guilherme Oliveira", email="luiz.oliveira@myabcm.com" }]
+	
+description = "MyABCM Corporate Python Client API"
+
+readme = "README.md"
+
+requires-python = ">=3.8"
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)"]
+
+license = { text= "LGPL-3.0-only" }
+
+dependencies = [
+    "requests>=2.32.3"]
+
+[project.urls]
+Homepage = "https://www.myabcm.com"
+Repository = "https://github.com/myabcm/corporate-python-client-api"

myabcm_corporate_client_api-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

myabcm_corporate_client_api-0.1.0/src/myabcm_corporate_client_api/__init__.py

@@ -0,0 +1 @@
+from .corporate_server_module import CorporateServer