Py4HEAppE 1.0.0__tar.gz

py4heappe-1.0.0/.gitignore

@@ -0,0 +1,15 @@
+# Visual Studio 2015 cache/options directory
+.vs/
+build/
+dist/
+py4heappe.egg-info/
+.vscode
+.idea/
+__pycache__
+.env
+lexis_logs.log
+py4heappe.log
+UNKNOWN.egg-info/dependency_links.txt
+UNKNOWN.egg-info/PKG-INFO
+UNKNOWN.egg-info/SOURCES.txt
+UNKNOWN.egg-info/top_level.txt

py4heappe-1.0.0/.gitlab/stages/.check.yml

@@ -0,0 +1,19 @@
+## CHECK STAGE
+
+check_changelog:
+  image: ${RELEASE_CLI_IMAGE}
+  stage: check
+  script:
+    - |
+      if git diff --name-only HEAD~1 HEAD | grep -q "CHANGELOG.md"; then
+        echo "CHANGELOG.md was modified."
+      else
+        echo "CHANGELOG.md was not modified."
+        exit 1
+      fi
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  only:
+    - master

py4heappe-1.0.0/.gitlab/stages/.publish.yml

@@ -0,0 +1,31 @@
+## PUBLISH STAGE
+
+publish_package:
+  stage: publish
+  image: python:3.11
+  needs:
+    - job: push_to_github_job
+  before_script:
+    - apt-get update
+    - apt-get install -y curl
+    - curl -s https://deb.nodesource.com/setup_18.x | bash
+    - pip install --upgrade awscli
+    - pip install GitPython
+    - pip install virtualenv
+    - virtualenv venv
+    - source venv/bin/activate
+  script:
+    - pip install build
+    - pip install twine
+    - python -m build
+    - TWINE_USERNAME=__token__ TWINE_PASSWORD=${PYPI_TOKEN}  python -m twine upload --repository pypi dist/*
+    - TWINE_USERNAME=gitlab-ci-token TWINE_PASSWORD=${CI_JOB_TOKEN} python -m twine upload --skip-existing --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  artifacts:
+    paths:
+      - dist/*.whl
+  only:
+    - master

py4heappe-1.0.0/.gitlab/stages/.release.yml

@@ -0,0 +1,105 @@
+# RELEASE STAGE
+
+release_msg_job:
+  stage: release
+  image: alpine:latest
+  needs:
+    - job: check_changelog
+  script:
+    - TAG_NAME=$(awk '/^## /{sub(/^## /, ""); print; exit}' CHANGELOG.md)
+    - TAG_MESSAGE=$(awk '/^### /{flag=1} /^## /{if(flag) exit} flag' CHANGELOG.md)
+    - TAG_MESSAGE_BASE64=$(echo -n "${TAG_MESSAGE}" | base64 -w 0)
+    - echo "TAG_NAME=${TAG_NAME}" >> release_variables.env
+    - echo "TAG_MESSAGE=${TAG_MESSAGE_BASE64}" >> release_variables.env
+  before_script:
+    - apk update && apk upgrade
+  variables:
+    GIT_STRATEGY: clone
+  artifacts:
+    reports:
+      dotenv: release_variables.env  
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  only:
+    - master
+
+release_job:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  needs:
+    - job: release_msg_job
+      artifacts: true                     
+  script:
+    - echo "Creating RELEASE \"$TAG_NAME"\"
+    - git config --global user.name "HEAppE Pipeline"
+    - git config --global user.email "support.heappe@it4i.cz" 
+    - git checkout master
+    - git status
+  before_script:
+    - apk update && apk upgrade
+    - apk add git
+  release:
+    name: '${TAG_NAME}'
+    description: '$(echo "${TAG_MESSAGE}" | base64 -d)'
+    tag_name: '${TAG_NAME}'
+  variables:
+    GIT_STRATEGY: clone
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  only:
+    - master
+
+push_to_github_job:
+  stage: release
+  needs:
+    - job: release_msg_job
+      artifacts: true
+  image: alpine:latest
+  script:
+     - git config --global user.name "HEAppE Pipeline"
+     - git config --global user.email "support.heappe@it4i.cz" 
+     - git checkout origin/master
+     - git remote add github https://x-access-token:$GITHUB_TOKEN@github.com/It4innovations/Py4HEAppE.git
+     - git push github HEAD:$CI_COMMIT_REF_NAME --force
+     - git push github --tags --force
+     - echo "${TAG_MESSAGE}"
+     - MODIFICATION_TAG_MESSAGE=$(echo "${TAG_MESSAGE}" | base64 -d | sed '/^[[:space:]]*$/s/^.*$/\\n/' | sed -E ':a;N;$!ba;s/\r{0,1}\n/\\n/g')
+     - |
+        BODY=$(jq -n --arg tag_name "$TAG_NAME" \
+                     --arg name "$TAG_NAME" \
+                     --arg body "$MODIFICATION_TAG_MESSAGE" \
+                     '{
+                        tag_name: $tag_name,
+                        name: $name,
+                        body: $body,
+                        draft: false,
+                        prerelease: false
+                      }')
+     - echo "${BODY}" | jq 
+     - |
+        HTTP_STATUS=$(curl -s -o response.txt -w "%{http_code}" -X POST -H "Authorization: token $GITHUB_TOKEN" -d "$BODY" https://api.github.com/repos/It4innovations/Py4HEAppE/releases)
+        if [ "$HTTP_STATUS" -ne 201 ]; then
+          echo "Error: Failed to create GitHub release. HTTP status code: $HTTP_STATUS"
+          cat response.txt  # Print the response for debugging
+          exit 1
+        else
+          echo "GitHub release created successfully. HTTP status code: $HTTP_STATUS"
+          echo "Response body:"
+          cat response.txt  # Print the response body
+        fi
+  before_script:
+    - apk update && apk upgrade
+    - apk add --no-cache git curl jq
+  variables:
+    GIT_STRATEGY: clone
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  only:
+    - master 
+

py4heappe-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,14 @@
+services:
+  - docker:dind
+
+include:
+  - local: '.gitlab/stages/.check.yml'
+  - local: '.gitlab/stages/.release.yml'
+  - local: '.gitlab/stages/.publish.yml'
+
+
+
+stages:
+  - check
+  - release
+  - publish

py4heappe-1.0.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+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).
+
+## V1.0.0
+
+###  Compatible with HEAppE V4.2.X and V4.3.X

py4heappe-1.0.0/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 HEAppE
+
+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.

py4heappe-1.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: Py4HEAppE
+Version: 1.0.0
+Summary: Py4HEAppE is client library for easy access to HEAppE Middleware
+Author-email: IT4Innovations <support.heappe@it4i.cz>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/It4innovations/Py4HEAppE
+Project-URL: Repository, https://github.com/It4innovations/Py4HEAppE.git
+Project-URL: Issues, https://github.com/It4innovations/Py4HEAppE/issues
+Keywords: LEXIS,HEAppE
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: paramiko==3.5.0
+Requires-Dist: scp==0.15.0
+Requires-Dist: urllib3==2.2.3
+Requires-Dist: certifi==2024.8.30
+Requires-Dist: six==1.16.0
+Requires-Dist: typer==0.13.1
+Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: validators==0.34.0
+Dynamic: license-file
+
+<img align="right" width="35%" src="https://raw.githubusercontent.com/It4innovations/Py4HEAppE/refs/heads/master/docs/imgs/logo.png">
+
+# 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: 
+The library abstracts the intricacies of the HEAppE API, allowing users to work with high-level concepts and operations.
+
+### 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.
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Prerequisites
+
+* 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
+# Initial Setup
+py4heappe Conf Init
+```
+
+All mentioned functions are aggregated to CLI's specific <b>commands groups (commands aggregations)</b>. To do so, type the following to provide help on how to use managers via CLI.
+
+```shell
+# List of commands groups (commands aggregations)
+py4heappe --help 
+```
+
+Available Commands Groups (commands aggregations): 
+
+```shell
+# Authentication commands group
+py4heappe Auth --help 
+
+# Command Template Management commands group
+py4heappe CmdTemp --help 
+
+# Information commands group
+py4heappe Info --help 
+
+# Report commands group
+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==3.5.0
+scp==0.15.0
+urllib3==2.2.3
+```
+
+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.
+
+```python
+import json
+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)
+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>

py4heappe-1.0.0/README.md

@@ -0,0 +1,122 @@
+<img align="right" width="35%" src="https://raw.githubusercontent.com/It4innovations/Py4HEAppE/refs/heads/master/docs/imgs/logo.png">
+
+# 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: 
+The library abstracts the intricacies of the HEAppE API, allowing users to work with high-level concepts and operations.
+
+### 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.
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Prerequisites
+
+* 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
+# Initial Setup
+py4heappe Conf Init
+```
+
+All mentioned functions are aggregated to CLI's specific <b>commands groups (commands aggregations)</b>. To do so, type the following to provide help on how to use managers via CLI.
+
+```shell
+# List of commands groups (commands aggregations)
+py4heappe --help 
+```
+
+Available Commands Groups (commands aggregations): 
+
+```shell
+# Authentication commands group
+py4heappe Auth --help 
+
+# Command Template Management commands group
+py4heappe CmdTemp --help 
+
+# Information commands group
+py4heappe Info --help 
+
+# Report commands group
+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==3.5.0
+scp==0.15.0
+urllib3==2.2.3
+```
+
+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.
+
+```python
+import json
+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)
+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>