Py4HEAppE 2.4.0__tar.gz → 2.5.1__tar.gz

{py4heappe-2.4.0 → py4heappe-2.5.1}/CHANGELOG.md

@@ -5,9 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.5.1
+
+### Compatible with HEAppE V6.2.X, V6.0.X, V5.0.X, V4.3.X and V4.2.X  
+### Changed
+
+- Dependencies relaxation.
+
+## 2.5.0
+
+### Compatible with HEAppE V6.2.X, V6.0.X, V5.0.X, V4.3.X and V4.2.X  
+
+
 ## 2.4.0
 
-### Compatible with HEAppE V6.1.X, V6.0.X, V5.0.X, V4.3.X and V4.2.X 
+### Compatible with HEAppE V6.1.X, V6.0.X, V5.0.X, V4.3.X and V4.2.X
 
 ## V2.3.0
 
@@ -18,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Compatible with HEAppE V5.0.X, V4.3.X and V4.2.X
 
 ### Changed
+
 - Update requirements package
 - Adding File Commands Groups in CLI (support Job Management)
 
@@ -26,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Compatible with HEAppE V5.0.X, V4.3.X and V4.2.X
 
 ### Changed
+
 - Requirements package (python-dotenv)
 
 ## V2.1.1
@@ -33,18 +47,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Compatible with HEAppE V5.0.X, V4.3.X and V4.2.X
 
 ### Fixed
+
 - Deserialization response for HEAppE 4.X.X
 
 ## V2.1.0
 
 ### Compatible with HEAppE V5.0.X, V4.3.X and V4.2.X
 
-
 ## V2.0.0
 
 ### Compatible with HEAppE V5.0.X
 
-
 ## V1.0.0
 
 ### Compatible with HEAppE V4.2.X and V4.3.X

{py4heappe-2.4.0 → py4heappe-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Py4HEAppE
-Version: 2.4.0
+Version: 2.5.1
 Summary: Py4HEAppE is client library for easy access to HEAppE Middleware
 Author-email: IT4Innovations <support.heappe@it4i.cz>
 License-Expression: MIT
@@ -13,12 +13,12 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: paramiko==4.0.0
+Requires-Dist: paramiko>=4.0.0
 Requires-Dist: scp==0.15.0
-Requires-Dist: urllib3==2.5.0
-Requires-Dist: certifi==2025.8.3
-Requires-Dist: six==1.17.0
-Requires-Dist: click==8.3.0
+Requires-Dist: urllib3>=2.0.2
+Requires-Dist: certifi>=2025.1.31
+Requires-Dist: six>=1.16.0
+Requires-Dist: click>=8.1.0
 Requires-Dist: typer>=0.15.0
 Requires-Dist: python-dotenv>=0.21.1
 Requires-Dist: validators==0.35.0
@@ -29,56 +29,64 @@ Dynamic: license-file
 # Py4HEAppE (Python for HEAppE Middleware)
 
 Py4HEAppE simplifies access to the [HEAppE](https://heappe.eu) features by providing a high-level Python interface that abstracts away the complexities of direct API interactions. This allows users to focus on their core tasks without worrying about the underlying details of API communication. It can be usable in <b>two modes</b> depends what the end-user needs:
+
 - HEAppE CLI Commands
 - HEAppE API Wrapper Library
 
 ## Key Benefits
 
 ### Ease of Use:
+
 Py4HEAppE provides a straightforward and intuitive interface for interacting with the HEAppE API. Users can perform complex operations with simple function calls.
 
-### Abstraction: 
+### Abstraction:
+
 The library abstracts the intricacies of the HEAppE API, allowing users to work with high-level concepts and operations.
 
-### Efficiency: 
+### Efficiency:
+
 By using Py4HEAppE, users can quickly integrate HEAppE functionalities into their Python applications, reducing development time and effort.
 
 ### Consistency:
+
 The library ensures consistent and reliable communication with the HEAppE API, handling errors and edge cases gracefully.
 
 ## Supported HEAppE versions
-| Py4HEAppE      | HEAppE Version              |  Notes                             |
-|:--------------:|:---------------------------:|:-----------------------------------|
-| 2.4.X          | 6.1.X, 6.0.X, 5.X.X, 4.X.X  | W/O Admin/File sections in CLI     |
-| 2.3.X          | 6.0.x, 5.0.X, 4.X.X         | W/O Admin/File sections in CLI     |
-| 2.2.X          | 5.0.X, 4.3.X, 4.2.X         | W/O Admin/File sections in CLI     |
-| 2.1.X          | 5.0.X, 4.3.X, 4.2.X         | W/O Admin/Job/File sections in CLI |
-| 2.0.X          | 5.0.X                       | W/O Admin/Job/File sections in CLI |
-| 1.X.X          | 4.3.X, 4.2.X                | W/O Admin/Job/File sections in CLI |
+
+| Py4HEAppE |          HEAppE Version          | Notes                              |
+| :-------: | :------------------------------: | :--------------------------------- |
+|   2.5.X   | 6.2.X 6.1.X, 6.0.X, 5.X.X, 4.X.X | W/O Admin/File sections in CLI     |
+|   2.4.X   |    6.1.X, 6.0.X, 5.X.X, 4.X.X    | W/O Admin/File sections in CLI     |
+|   2.3.X   |       6.0.x, 5.0.X, 4.X.X        | W/O Admin/File sections in CLI     |
+|   2.2.X   |       5.0.X, 4.3.X, 4.2.X        | W/O Admin/File sections in CLI     |
+|   2.1.X   |       5.0.X, 4.3.X, 4.2.X        | W/O Admin/Job/File sections in CLI |
+|   2.0.X   |              5.0.X               | W/O Admin/Job/File sections in CLI |
+|   1.X.X   |           4.3.X, 4.2.X           | W/O Admin/Job/File sections in CLI |
 
 <!-- GETTING STARTED -->
+
 ## Getting Started
 
 ### Prerequisites
 
-* Python (version 3.11)
-* Pip (package installer)
-* Access to Deployed HEAppE instance (HEAppE instance URL and HPC project identificator)
+- Python (version 3.11)
+- Pip (package installer)
+- Access to Deployed HEAppE instance (HEAppE instance URL and HPC project identificator)
 
 ### Installation
 
 ```
 pip install Py4HEAppE
- ```
+```
 
 <b>Note:</b> In some cases, you can obtain a warning message like this <b>"WARNING: The script py4heappe.exe is installed in 'C:\Users\user\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.</b>" If you obtained a similar warning message, it is necessary to add the mentioned path into your operation system <b>PATH</b> variable or use a path with an executable file (i.e. C:\Users\user\AppData\Roaming\Python\Python311\Scripts\py4heappe.exe).
 
-
 ## HEAppE CLI
 
 The HEAppE CLI (Command Line Interface) provides a convenient way to interact with the HEAppE Middleware directly from your terminal. It allows users to perform various operations such as authentication, job management, and information retrieval without needing to write any code. This makes it an ideal tool for end-users who need to manage HEAppE Instance efficiently.
 
 ### Usage
+
 For using HEAppE CLI it is neeaded to initializing Py4HEAppE for usage with a specific HEAppE Instance (It is necessary to call for the first usage). Command requires <b>HPC project accounting string</b> and <b>HEAppE Instance URL</b>.
 
 ```shell
@@ -90,43 +98,44 @@ All mentioned functions are aggregated to CLI's specific <b>commands groups (com
 
 ```shell
 # List of commands groups (commands aggregations)
-py4heappe --help 
+py4heappe --help
 ```
 
-Available Commands Groups (commands aggregations): 
+Available Commands Groups (commands aggregations):
 
 ```shell
 # Authentication commands group
-py4heappe Auth --help 
+py4heappe Auth --help
 
 # Command Template Management commands group
-py4heappe CmdTemp --help 
+py4heappe CmdTemp --help
 
 # Information commands group
-py4heappe Info --help 
+py4heappe Info --help
 
 # Job Management commands group
 py4heappe Job --help
 
 # Report commands group
-py4heappe Report --help 
+py4heappe Report --help
 ```
 
 <b>Note:</b> On Windows operation system need to use <b>"py4heappe.exe"</b> instead of <b>"py4heappe"</b>.
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## HEAppE API Wrapper Library
 
 In this mode, the Py4HEAppE package is used as a wrapper for HEAppE API specification. It allows users to perform various operations from <b>HEAppE API</b>, such as authentication, job management, and information retrieval, without needing to write their API wrapper code. It can be easily integrated with internal <b>Python</b> projects that HEAppE Middleware wants to be used. More information about usability can be found in the section below.
- 
+
 ### Usage
- 
+
 It is required to specify following modules in "requirements.txt" file.
- 
+
 ```text
-paramiko==4.0.0
+paramiko>=4.0.0
 scp==0.15.0
-urllib3==2.5.0
+urllib3>=2.0.2
 ```
 
 The code snapshot illustrated an example of "how to" obtain cluster information from the HEAppE Instance. For more detailed examples of basic HPC workflow, please refer to the [example.py](https://github.com/It4innovations/Py4HEAppE/blob/master/docs/examples/example.py) file.
@@ -137,14 +146,14 @@ import os
 import time
 from io import StringIO
 from pathlib import Path
- 
+
 import py4heappe.core as hp
- 
+
 print("\nFetching cluster info...")
 lac_body = {
     "_preload_content": False
 }
- 
+
 ciEndpoint = hp.ClusterInformationApi(api_instance)
 r = ciEndpoint.heappe_cluster_information_list_available_clusters_get(**lac_body)
 r_data = json.loads(r.data)
@@ -153,7 +162,6 @@ print(json.dumps(r_data, indent = 3))
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-
 ## Acknowledgement
 
 e-Infra CZ

{py4heappe-2.4.0 → py4heappe-2.5.1}/README.md

@@ -3,56 +3,64 @@
 # Py4HEAppE (Python for HEAppE Middleware)
 
 Py4HEAppE simplifies access to the [HEAppE](https://heappe.eu) features by providing a high-level Python interface that abstracts away the complexities of direct API interactions. This allows users to focus on their core tasks without worrying about the underlying details of API communication. It can be usable in <b>two modes</b> depends what the end-user needs:
+
 - HEAppE CLI Commands
 - HEAppE API Wrapper Library
 
 ## Key Benefits
 
 ### Ease of Use:
+
 Py4HEAppE provides a straightforward and intuitive interface for interacting with the HEAppE API. Users can perform complex operations with simple function calls.
 
-### Abstraction: 
+### Abstraction:
+
 The library abstracts the intricacies of the HEAppE API, allowing users to work with high-level concepts and operations.
 
-### Efficiency: 
+### Efficiency:
+
 By using Py4HEAppE, users can quickly integrate HEAppE functionalities into their Python applications, reducing development time and effort.
 
 ### Consistency:
+
 The library ensures consistent and reliable communication with the HEAppE API, handling errors and edge cases gracefully.
 
 ## Supported HEAppE versions
-| Py4HEAppE      | HEAppE Version              |  Notes                             |
-|:--------------:|:---------------------------:|:-----------------------------------|
-| 2.4.X          | 6.1.X, 6.0.X, 5.X.X, 4.X.X  | W/O Admin/File sections in CLI     |
-| 2.3.X          | 6.0.x, 5.0.X, 4.X.X         | W/O Admin/File sections in CLI     |
-| 2.2.X          | 5.0.X, 4.3.X, 4.2.X         | W/O Admin/File sections in CLI     |
-| 2.1.X          | 5.0.X, 4.3.X, 4.2.X         | W/O Admin/Job/File sections in CLI |
-| 2.0.X          | 5.0.X                       | W/O Admin/Job/File sections in CLI |
-| 1.X.X          | 4.3.X, 4.2.X                | W/O Admin/Job/File sections in CLI |
+
+| Py4HEAppE |          HEAppE Version          | Notes                              |
+| :-------: | :------------------------------: | :--------------------------------- |
+|   2.5.X   | 6.2.X 6.1.X, 6.0.X, 5.X.X, 4.X.X | W/O Admin/File sections in CLI     |
+|   2.4.X   |    6.1.X, 6.0.X, 5.X.X, 4.X.X    | W/O Admin/File sections in CLI     |
+|   2.3.X   |       6.0.x, 5.0.X, 4.X.X        | W/O Admin/File sections in CLI     |
+|   2.2.X   |       5.0.X, 4.3.X, 4.2.X        | W/O Admin/File sections in CLI     |
+|   2.1.X   |       5.0.X, 4.3.X, 4.2.X        | W/O Admin/Job/File sections in CLI |
+|   2.0.X   |              5.0.X               | W/O Admin/Job/File sections in CLI |
+|   1.X.X   |           4.3.X, 4.2.X           | W/O Admin/Job/File sections in CLI |
 
 <!-- GETTING STARTED -->
+
 ## Getting Started
 
 ### Prerequisites
 
-* Python (version 3.11)
-* Pip (package installer)
-* Access to Deployed HEAppE instance (HEAppE instance URL and HPC project identificator)
+- Python (version 3.11)
+- Pip (package installer)
+- Access to Deployed HEAppE instance (HEAppE instance URL and HPC project identificator)
 
 ### Installation
 
 ```
 pip install Py4HEAppE
- ```
+```
 
 <b>Note:</b> In some cases, you can obtain a warning message like this <b>"WARNING: The script py4heappe.exe is installed in 'C:\Users\user\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.</b>" If you obtained a similar warning message, it is necessary to add the mentioned path into your operation system <b>PATH</b> variable or use a path with an executable file (i.e. C:\Users\user\AppData\Roaming\Python\Python311\Scripts\py4heappe.exe).
 
-
 ## HEAppE CLI
 
 The HEAppE CLI (Command Line Interface) provides a convenient way to interact with the HEAppE Middleware directly from your terminal. It allows users to perform various operations such as authentication, job management, and information retrieval without needing to write any code. This makes it an ideal tool for end-users who need to manage HEAppE Instance efficiently.
 
 ### Usage
+
 For using HEAppE CLI it is neeaded to initializing Py4HEAppE for usage with a specific HEAppE Instance (It is necessary to call for the first usage). Command requires <b>HPC project accounting string</b> and <b>HEAppE Instance URL</b>.
 
 ```shell
@@ -64,43 +72,44 @@ All mentioned functions are aggregated to CLI's specific <b>commands groups (com
 
 ```shell
 # List of commands groups (commands aggregations)
-py4heappe --help 
+py4heappe --help
 ```
 
-Available Commands Groups (commands aggregations): 
+Available Commands Groups (commands aggregations):
 
 ```shell
 # Authentication commands group
-py4heappe Auth --help 
+py4heappe Auth --help
 
 # Command Template Management commands group
-py4heappe CmdTemp --help 
+py4heappe CmdTemp --help
 
 # Information commands group
-py4heappe Info --help 
+py4heappe Info --help
 
 # Job Management commands group
 py4heappe Job --help
 
 # Report commands group
-py4heappe Report --help 
+py4heappe Report --help
 ```
 
 <b>Note:</b> On Windows operation system need to use <b>"py4heappe.exe"</b> instead of <b>"py4heappe"</b>.
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## HEAppE API Wrapper Library
 
 In this mode, the Py4HEAppE package is used as a wrapper for HEAppE API specification. It allows users to perform various operations from <b>HEAppE API</b>, such as authentication, job management, and information retrieval, without needing to write their API wrapper code. It can be easily integrated with internal <b>Python</b> projects that HEAppE Middleware wants to be used. More information about usability can be found in the section below.
- 
+
 ### Usage
- 
+
 It is required to specify following modules in "requirements.txt" file.
- 
+
 ```text
-paramiko==4.0.0
+paramiko>=4.0.0
 scp==0.15.0
-urllib3==2.5.0
+urllib3>=2.0.2
 ```
 
 The code snapshot illustrated an example of "how to" obtain cluster information from the HEAppE Instance. For more detailed examples of basic HPC workflow, please refer to the [example.py](https://github.com/It4innovations/Py4HEAppE/blob/master/docs/examples/example.py) file.
@@ -111,14 +120,14 @@ import os
 import time
 from io import StringIO
 from pathlib import Path
- 
+
 import py4heappe.core as hp
- 
+
 print("\nFetching cluster info...")
 lac_body = {
     "_preload_content": False
 }
- 
+
 ciEndpoint = hp.ClusterInformationApi(api_instance)
 r = ciEndpoint.heappe_cluster_information_list_available_clusters_get(**lac_body)
 r_data = json.loads(r.data)
@@ -127,10 +136,9 @@ print(json.dumps(r_data, indent = 3))
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-
 ## Acknowledgement
 
 e-Infra CZ
 This work was supported by the Ministry of Education, Youth and Sports of the Czech Republic through the e-INFRA CZ (ID:90254)
 
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

py4heappe-2.5.1/Tools/APIWrapperGen/README.md

@@ -0,0 +1,15 @@
+# Py4HEAppE API Client Generation
+
+The content contains how to re-generate the HEAppE API wrapper with the new version of the HEAppE API
+
+## Steps
+
+1. Obtain HEAppE API Swagger definition **(eg.http://localhost:5000/swagger/py4heappe/swagger.json)**
+2. Update server url in swagger.json file to <http://localhost:5000>
+3. Upload the downloaded Swagger definition and replace it in repository folder **'Tools\APIWrapperGen\swagger.json'**
+4. Modify packageName (change version) in file **'Tools\APIWrapperGen\config.json' (packageName: "py4heappe.heappe_v\*.core)**
+5. Commit into random branch (not into develop or main)
+6. Manually triggered pipeline for the API wrapper generation
+7. Download pipeline artefact and put files in **'src\py4heappe\core\version'**
+8. Modify Py4HEAppE CLI affected commands and imports to specific version
+9. Modify import to specific version in **'docs\examples\example.py'**